Skip to content

bytezera04/TinyURL-backend

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

11 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ“ TinyURL Backend

TinyURL Backend is an API that powers a URL shortening service. It allows creating shortened URLs and fetching statistics on the most clicked URLs.

✨ Features

  • πŸ”— Create shortened URLs
  • πŸ“Š Fetch statistics for the most clicked URLs
  • ⚑ Built with Python, FastAPI, and PostgreSQL
  • 🐧 Easy deployment on Linux

🌐 API Endpoints

πŸ“ TinyURL Backend

TinyURL Backend is an API that powers a URL shortening service. It allows creating shortened URLs and fetching statistics on the most clicked URLs.

✨ Features

  • πŸ”— Create shortened URLs
  • πŸ“Š Fetch statistics for the most clicked URLs
  • ⚑ Built with Python, FastAPI, and PostgreSQL

🌐 API Endpoints

  • POST /urls – Create a new shortened URL
  • GET /urls/top – Get the most clicked URLs
  • GET /urls/{short_id} – Get redirect URL data

🌐 Frontend

Check out the frontend for this project here: TinyURL Frontend

πŸ› οΈ Tech Stack

  • Python – Core language
  • FastAPI – High-performance API framework
  • PostgreSQL – Relational database for storing URLs and stats

πŸš€ Deployment

Can be deployed on Linux servers or cloud platforms supporting Python and PostgreSQL.

πŸ’» Usage

  1. Clone the repository
    git clone https://github.com/bytezera04/TinyURL-backend.git
  2. Install dependencies
    pip install -r requirements.txt
  3. Run the server
    uvicorn main:app --reload
  4. Access the API at http://localhost:8000

πŸ“„ License

This project is open source.

About

TinyURL clone backend. Python FastAPI + Postgres

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published