21B030951 Madina Yantay

Go URL Shortener

Overview

This is a simple URL shortener written in Go. It allows you to shorten long URLs into manageable links that never expire.

How does a URL shortener work?

At a high level, the URL shortener executes the following operations:

• the server generates a unique short URL for each long URL or user creates own custom one
• the server encodes the short URL for readability
• the server persists the short URL in the data store
• the server redirects the client to the original long URL against the short URL

Features

• Shorten URLs
• Custom alias for URLs
• Basic analytics (click counts)

REST API

POST /urls
GET /urls/:id
PUT /urls/:id
DELETE /urls/:id

GET /healthcheck

GET /shortenings
GET /shortenings/:identifier
PATCH /shortenings/:identifier
DELETE /shortenings/:identifier

POST /users
PUT /users/activated
GET /users/:id/shortenings
POST /users/:id/shortenings
POST /tokens/authentication

Structure of entities in the database

High-level system design

Prerequisites

• Go 1.16 or higher
• PostgreSQL 13.0 or higher

Installation

1. Clone the repository:

git clone https://github.com/yantay0/url-shortener.git