paulsheridan / grackle

A feature-packed booking platform for tattoo artists.

Grackle Tattoo Scheduling

A scheduling and booking application for tattoo artists.

Technology Stack and Features

• ⚡ FastAPI for the Python backend API.
  • 🧰 SQLModel for the Python SQL database interactions (ORM).
  • 🔍 Pydantic, used by FastAPI, for the data validation and settings management.
  • 💾 PostgreSQL as the SQL database.
• 🐋 Docker Compose for development and production.
• 🔑 JWT token authentication.
• 📫 Email based password recovery.
• ✅ Tests with Pytest.

Requirements

• Docker.
• Poetry for Python package and environment management.

Local Development

• Start the stack with Docker Compose:

make up

• Follow the backend logs:

make follow

Interact with API: http://localhost:8888/api/v1

Automatic interactive documentation with Swagger UI (from the OpenAPI backend): http://localhost:8888/docs

To check the logs, run:

docker compose logs

To check the logs of a specific service, add the name of the service, e.g.:

docker compose logs backend

General workflow

By default, the dependencies are managed with Poetry, go there and install it.

From ./backend/ you can install all the dependencies with:

$ poetry install

Then you can start a shell session with the new environment with:

$ poetry shell