URL Shortener - Omni HR Full Stack Assignment #1

1. Docker + Docker Compose

1. Copy root environment variables. - This is used for running the PostgreSQL through Docker

cp .env.example .env

2. Copy backend environment variables

cp ./backend/.env.example ./backend/.env

3. Copy frontend environment variables

cp ./frontend/.env.example ./frontend/.env

4. Run docker compose - Run production ready services

docker compose up -d

5. Run initial backend migration

docker exec -it omnihr-url-shortener-backend-1 python manage.py migrate

6. Open localhost:3000 in your browser

7. (Optional) - Run containers for development

docker compose -f docker-compose.dev.yaml up

If I have more time, I will:

1. Add unit tests
2. Add caching to Get URL APIs
3. Clean database data for expired short URLs
4. Measure performance by doing load testing to the APIs
5. Fine tune nginx and gunicorn webservers

MIT