URL Shortener API

Stack & Features

• 🌐 FastAPI for Python backend.
  • 📋 Pydantic, used for data validation and settings management.
  • 💾 PostgreSQL as SQL Database.
• 🐋 Docker for development, testing and production.
• 🏭 CI/CD with GitHub Actions.
• 🔑 JWT based authentication.
• ✅ Tests with Pytest.
• 🔒 Secure password hashing.
• ✉️ Password recovery with email.

Warning

This repository is part of a larger project that consists of multiple repositories. Using this repository on its own is not recommended, as it may not function correctly without the other components of the project. For complete functionality and proper integration, please refer to the kramber1024/url-shortener.

Local launch

Requirements

• 🐍 Python 3.12

Installation

Clone the repository:

git clone https://github.com/kramber1024/url-shortener-api.git

Navigate to the project directory:

cd url-shortener-api

Create a virtual environment:

python -m venv venv

Activate the virtual environment:

• On Linux and macOS:

  source venv/bin/activate

• On Windows:

  .\venv\Scripts\activate

Install Poetry package manager:

pip install poetry

Install dependencies required to run the project:

poetry install --only main --no-root

Run the project:

python -m app.main

You can see the result by navigating to one of the following addresses:

• http://127.0.0.1:26801/api/docs - Swagger UI
• http://127.0.0.1:26801/api/redoc - ReDoc

Note

Documentation for testing, running in Docker, and environment variables can be found in DEVELOPMENT.md.

License

This project is licensed under the terms of the MIT license.