TripTip project - triptip_backend

Backend part of travel portal TripTip

Preparation

Before you start, make sure you have the following installed:

• Python 3.12+ (Make sure Python is added to your PATH)

• uv (for dependency management)

Installation

Install uv with our standalone installers:

# On macOS and Linux.
curl -LsSf https://astral.sh/uv/install.sh | sh

# On Windows.
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

Or, from PyPI:

# With pip.
pip install uv

# Or pipx.
pipx install uv

If installed via the standalone installer, uv can update itself to the latest version:

uv self update

See the installation documentation for details and alternative installation methods.

Documentation

uv's documentation is available at docs.astral.sh/uv.

Additionally, the command line reference documentation can be viewed with uv help.

Features

Projects

uv manages project dependencies and environments, with support for lockfiles, workspaces, and more, similar to rye or poetry:

To run this project do the following:

1. Install poetry dependencies:

uv venv

2. Install venv:

source .venv/bin/activate

3. Sync dependencies:

uv sync

4. Copy environment sample

cp .env_sample .env

5. Run project:

Locally:

make run

In container:

make run_trip_tip_backend_in_container

API Documentation

Code style:

1. Use black style - Black style guide;

2. Line length 100 symbols;

3. Don't forget to docstring and comment.

Current stack:

Python 3.12, FastAPI, Uvicorn, Postgres, Docker, pytest, nginx, Ruff

Creators:

Ivan Murzinov Frontend, Project Founder

Polina Bykova UX/UI

Pavel Surint QA/Backend

Nikita Assorov Backend