URL Shortener

An application that allows users to convert long URLs to short, manageable links. It provides RESTful APIs for creating and managing short URLs, powering the URL Shortener Frontend, a Next.js application that offers user-friendly interface for interacting with the service. The backend handles URL shortening, redirection, and deletion.

Table of Contents

• Features
• Prerequisites
• Installation
• Usage
• Contribution

Features

• URL Shortening: Generates concise, unique short links from long URLs
• Link Redirection: Redirects short URLs to their original destination
• URL Deletion: Allows users to delete short URLs, removing them from the system

Prerequisites

To run this project locally, ensure you have the following installed:

• Python (v3.8 or higher)
• pip for package management
• Git for version control

Installation

1. Clone the Repository

   git clone https://github.com/MeenakshiPathiyil/URLShortener.git
   cd URLShortener
   

2. Install Dependencies

   pip install -r requirements.txt
   

Usage

1. Start the Backend

   python main.py
   

2. Start the Frontend

   npm run dev
   

Contributions

Contributions to this project are welcome! If you have any suggestions, improvements or bug reports, please open an issue on the GitHub repository.