Skip to content
/ api Public

Server-side of Randorm: GraphQL API and Telegram Integration

License

Notifications You must be signed in to change notification settings

randorm/api

Repository files navigation

Repo Poster

Features

Build Status

Build and public image

Conventions

Dev Tools

Tool Description
ruff formatter black-compatible formatter with better default options - source of truth for code style & format
ruff the fastest & most accurate python linter
precommit-hooks manages git hooks
just imporved version of make - task runner

Project Setup

  1. Install python 3.12
  2. Install poetry v1.8.2
  3. Install just (installation guide)
  4. Create a virtual environment, install dependencies, preheat pre-commit hooks and more using:
just setup
  1. Activate the virtual environment in current shell using:
poetry shell

Development

Formatting

To sort imports and format code run:

just tidy

Linting

To lint code run:

just check

Testing

just test

Launch API

just run-server

Docker

just docker-build
just docker-run