This project is a low config url shortener made for hobby. It uses a SQLite database hosted at an auto created .db file, so the only thing you need to do to run is... run it.

By following these instructions you will get the server running on your local machine.

You can Take the Windows Bynary on the latest tag and execute, or run the following commands:

go install github.com/Hilson-Alex/url_shortener@latest
url_shortener

When running, the program will be serving on a port (usually localhost:8080). It supplies some API endpoints for shortening and a small and simple frontend as well.

The server routes are the following:

• {host}/app:

  Allows the User to create a short URL with an expire date between 1 and 30 days and shows the resulting shortened URL.

• {host}/app/list:

  List all shortened URLs

• {host}/to/:key:

  The actual short URL. Redirects the user for an URL based on the passed key

• {host}/short/create

  Create a new short URL, it doesn't duplicate URLs in the database. In case of conflict, the longest expire date is kept on the database, but the user expire date is returned to not confuse the user.

  • Receives a JSON with:

    {
      originalUrl: string, // The URL to be shortened
      expireDate: integer  // The number of DAYS to keep the URL active
    }

  • Returns:

    {
      key: string,         //The resulting key for the short url
      originalUrl: string, // The URL to be shortened
      expireDate: integer, // The number of UNIX timestamp for the expire date
      shortUrl: string     // The shortened URL. {host}/to/:key
    }

• {host}/short/:key

  Get the shortened URL without redirecting.

  • Returns:

    {
      key: string,         //The resulting key for the short url
      originalUrl: string, // The URL to be shortened
      expireDate: integer, // The number of UNIX timestamp for the expire date
      shortUrl: string     // The shortened URL. {host}/to/:key
    }

• {host}/short/list

  Get All the Shortened URL.

  • Returns:

    [
      {
        key: string,         //The resulting key for the short url
        originalUrl: string, // The URL to be shortened
        expireDate: integer, // The number of UNIX timestamp for the expire date
        shortUrl: string     // The shortened URL. {host}/to/:key
      },
      // more
    ]

To get the repository running locally on your machine you will need to install the Go compiler

You can clone the project by running

git clone [email protected]:Hilson-Alex/url_shortener.git

or, if you can't use ssh

git clone https://github.com/Hilson-Alex/url_shortener.git

Next, open the project folder and run:

go run .

Or, you can build the binary instead:

go build

And then you will have a url_shortener.exe on the root folder.

• Gin was used to handle the server endpoints and build the API
• ncrues/go-sqlite3 was used as a GCO-free alternative for the sqlite database driver

Semantic Versioning was used for versioning. For the versions available, see the tags on this repository.

• Hilson A. W. Junior - Initial work

This project is under the GNU AGPLv3 - for more info read the LICENSE file.