This Project is a single-page website that can handle shortening long URLs in Javascript. Backend is developed using node.js and express. On the other hand, Vuetify handles the Frontend side. Other details of the project are listed below:
- Short URL is created using CRC32 encoding system.
- Adding new URLs or Delete old ones are handled by REST API.
- Every URL is stored in a MongoDB provided by free Atlas Cloud services.
NOTE: Atlas is NOT available in Iran, So while working with this repo you have to use a VPN connection!
-
This repo is runnable using Docker
-
Using Vutify as frontend is responsive and graphically acceptable.
The easiest way to run the code is using docker-compose
Ensure you have installed Docker and docker-compose on your system. You can find installation instructions in the links below:
- Docker Installation: https://docs.docker.com/get-docker/
- docker-compose installation: https://docs.docker.com/compose/install/
To check if Docker and docker-compose are correct, you can run the codes below:
docker -v
docker-compose -v
If there were no errors then everything is working OK.
After you have installed Docker and docker-compose go to the main folder and run the code below:
docker-compose up
Docker automatically downloads dependencies and runs the server.
You can access the web app through the location below:
http://localhost:3000