For now, the project only has 3 core features:
- Create a new shorten url.
- View information about n existing shorten url.
- Delete a shorten url.
- Redirect to original url.
For using the project on your own, follow this steps:
- Clone the project:
git clone https://github.com/CarlosDanielMaturano/rurl.git - Setup the database:
cargo run --bin setup-database - Run the project:
cargo run
The project includes a Dockerfile and a compose.yaml for containerization.
Build the image
- You can build the image by using:
docker build . -t rurlIt will a create a new image called 'rurl'
Run the image
- For running the image use:
docker run -p 4000:4000 rurlAnd the api will be running under:http://0.0.0.0:4000
Compose
- You can skip this hole process just by running:
docker-compose up
See Docs.
The project is under MIT license.