Welcome to url-shortener 👋

Url Shortener built using Nest js 🚀, Angular 🅰️ , Docker 🐳 inside Nrwl Nx workspace.

Pre-requisites :-

1. Docker
2. Docker Compose
3. Node js
4. Npm

Usage :-

1. Create a Environment file (dev.env) in the root of the cloned project.

touch dev.env

2. Set the below variables in the dev.env file

Name	Value
POSTGRES_HOST	url-shortener-db
POSTGRES_PORT	5432
POSTGRES_USER	postgres
POSTGRES_PASSWORD	12345
POSTGRES_DATABASE	url-shortener
REDIS_HOST	url-shortener-redis
REDIS_PORT	6379
PORT (Api Server)	3333
APP_MODE	DEV
URL_DOMAIN	localhost

1. Build all the docker files using the shell script using dev as environment.

./docker-build-all.sh dev

4. Run the project using docker compose.

docker-compose -f docker-compose_dev.yml up

5. Stop the project using docker compose. (Optional)

docker-compose -f docker-compose_dev.yml down

Upcoming changes

1. Setting up Nginx as a load balancer and reverse proxy.

2. Top frequent url's using Redis sorted sets.

3. Setup the project for production ready.

4. Add unit tests for api and frontend using jest.

5. Configure Circle CI for docker build and unit tests.

Dockerhub images (Public)

1. https://hub.docker.com/repository/docker/kaushiksamanta/url-shortener-api
2. https://hub.docker.com/repository/docker/kaushiksamanta/url-shortener-client

Screenshots

1. Url-shortener UI:-

1. Docker compose runner:-

3. Docker build:-

Author

👤 Kaushik Samanta

• Website: kaushiksamanta.github.io
• Github: @kaushiksamanta
• LinkedIn: @kaushik-samanta

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

---