Short URL Project

User Guide

1. Clone the repository to your local machine using the following command:

git clone https://github.com/domingo1021/short-url.git

2. (Optional) If you prefer using a pre-built Docker image, you can pull the Short URL Docker image from Docker Hub:

docker pull domingo1021/url-app

3. Run docker compose to start all the needed containers.

docker compose up

4. Open Swagger UI at http://localhost:3000/apidocs for documentation, and check if the server have started.