README.md

URL Shortener

---

URL Shortener is a project that shortens the URL and provides a unique short code for each URL. It is a simple project that can be used to shorten the URL even with custom code and use it in the place of the original URL.

📝 Table of Contents

• About
• Getting Started
• Built Using
• TODO
• Author

🧐 About

This project is a simple URL shortener that shortens the URL and provides a unique short code for each URL. It is a simple project that can be used to shorten the URL even with custom code and use it in the place of the original URL. It uses firebase to store the URL and the short code in a mapping.

The project is developed using FastAPI which is a modern, fast (high-performance), web framework for building APIs with Python 3.6+ based on standard Python type hints.

A very Simple front end is also provided to shorten the URL which is developed using FastUI.

🏁 Getting Started

Prerequisites

• Python 3.11
• Poetry
• Docker

Installing

Follow these steps to install the project on your local machine.

1. Clone the repository

git clone https://github.com/AmulyaParitosh/UrlShortener.git

2. Change the working directory

cd UrlShortener

3. Install the dependencies

poetry install

4. Run the server

poetry run uvicorn main:app --reload

Or with Docker

docker-compose up

5. Open the browser and go to http://localhost:8000

⛏️ Built Using

• Python - Programming Language
• FasiAPI - Web Framework
• Firebase - Realtime Database
• FastUI - Frontend Framework
• Docker - Containerization