Shortener

• Overview
• Prerequisites
• Installation
• Usage
• Architecture

Overview

The project consists of two main services:

• Shortener Service: Handles the creation of short URLs.
• Redirector Service: Handles the redirection from short URLs to the original URLs.

Getting Started

Prerequisites

• Docker
• Docker Compose

Installation

1. Clone the repository:

   git clone https://github.com/onemoreslacker/shortener.git

2. Navigate to the project directory:

   cd shortener

3. Create a .env file from the example:

   cp deploy/.env.example deploy/.env

4. Run the services using Docker Compose:

   make up

This will start the shortener and redirector services, along with a MongoDB instance and a Caddy reverse proxy.

Usage

You can access web interface via the link http://localhost:80, paste link which you want to shorten and get the shortened link.

Architecture