Shortener API in Golang

This is a simple API in Golang that accepts a URL in the query parameter and returns a shortened link that will redirect the user to the original URL.

Prerequisites

To run the project, you need to have the following tools installed on your system:

• make: The build automation tool.
• Docker: To run the container with the Postgres database.

Getting Started

1. Clone the repository to your local machine:

   git clone https://github.com/your-username/shortener-api.git
   cd shortener-api

2. Install Go in your machine, and follow the instruction in the following url:

   https://go.dev

3. Install Make in your machine, and follow the instruction in the following url:

   https://www.gnu.org/software/make/

4. Initialize the Postgres database container:

   make postgresinit

5. Add environment variables below to your environment:

   # Your base URL
   BASE_URL=
   
   # Your url connection string
   DATABASE_URL=

6. Initialize the Postgres database container:

   make createdb

7. Run the database migrations:

   make migrateup

8. Finally, run the API locally:

   make run

Making Requestes to the API

You can use curl or any other HTTP client to interact with the API.

Shorten a URL

To shorten a URL, make a POST request with the url query parameter. The API will return a shortened link.

curl -X POST "http://localhost:8000/?url=https://www.example.com"

Sample Response:

{
  "url": "http://localhost:8080/EawUrx"
}

Redirect to the Original URL

To be redirected to the original URL, simply open the shortened URL in your browser

http://localhost:8000/EawUrx

This will redirect you to https://www.example.com.