Shortly is a simple web service that generates short URLs from long ones. It was created by Fran P. as a personal project, and the public version is closed to some users. Of course, you can deploy it by yourself using Docker. Is currently hosted at https://shortly.franp.site.

• Shorten any long URL
• Simple and easy to use API
• Users register and login

• Description: Retrieves user data using email/username and password.

• Headers:

  Header Key	Required	Type	Description
  url	Yes	String	Original URL to shorten
  email	Yes	String	User email address
  username	Yes	String	User username
  password	Yes	String	User password

• Result: Returns user data.

• Description: Creates a new user.

• Headers:

  Header Key	Required	Type	Description
  email	Yes	String	User email address
  username	Yes	String	User username
  password	Yes	String	User password
  role	Yes	String (enum: ADMIN)	User role (ADMIN is the only valid value currently supported)
  sponsor_uid	No	String	Sponsor ID
  first_user_password	No	String	Password of the first user created by this admin (for admin users only)

• Result: Returns a success message indicating that the user was added.

• Description: Adds a new short URL.

• Headers:

  Header Key	Required	Type	Description
  url	Yes	String	Original URL to shorten
  email	Yes	String	User email address
  username	Yes	String	User username
  password	Yes	String	User password

• Result: Returns the new short URL.

• Description: Redirects to the original URL associated with the given short URL ID.

• Headers: N/A

• Result: Redirects the user to the original URL.

To run the Shortly API using Docker Compose, follow these steps:

Install Docker and Docker Compose: If you haven't already, you'll need to install Docker and Docker Compose on your computer.

1. Clone the repository: Clone the Shortly API repository to your computer using Git:

   git clone [email protected]:FranP-code/shortly.git

2. Build the Docker image: Open a terminal in the root directory of the project and run the following command to build the Docker image:

   docker-compose build

3. Run the Docker container: Once the Docker image is built, you can run a container based on it using the following command:bash

   docker-compose up

4. Access the API: You can now access the Shortly API by visiting http:https://localhost:3000 in your web browser or sending requests to the API endpoint using tools like curl.

The API can be configured using environment variables. The following variables can be set in a .env file in the root directory of the project:

• NODE_ENV: The environment in which the API is running, either "development" or "production". Defaults to "development".