/url-shortener

A Python-based URL shortener built with FastAPI

Primary LanguagePythonMIT LicenseMIT

Python FastAPI URL Shortener

GitHub Workflow Status Code style: black MIT license

Features

  • Fast URL Shortening: Quickly shorten any long URL.
  • FastAPI Framework: Built with the modern, fast (high-performance) FastAPI framework.
  • Docker-Compose Ready: Easily set up and run with Docker Compose.

Installation using Docker Compose

Use Docker Compose for a quick and straightforward setup:

  1. Download docker-compose.yml File:

    • With wget: 
      wget https://raw.githubusercontent.com/barabum0/url-shortener/main/docker-compose.yml
    • Manually: docker-compose.yml

  2. Start the Service:

    docker-compose up -d  # or docker compose up -d

Contributing

Contributions are welcome. Please fork the repository, make your changes, and submit a pull request.

License

This project is open-sourced under the MIT License.