CubeCrit

A website for reviewing speedcubes.

Local Development

Requirements

• Python 3.11
• Poetry
• Docker
  • You can also install and run PostgreSQL instead of using the Docker Compose commands

Commands

# install dependencies
poetry install

# run formatters/apply fixes
poetry run poe format

# run linters/apply checks
poetry run poe lint

# run tests
poetry run pytest

Running Locally

# start the local postgres db server on localhost:5432
docker compose up db

# set environment variables
export DB_ADDRESS="postgresql://cubecrit:password@localhost:5432/cubecrit"

# set environment variables for powershell
$Env:DB_ADDRESS="postgresql://cubecrit:password@localhost:5432/cubecrit"

# start the debug server on localhost:3000
poetry run poe flask-debug

Database Schema

DB Diagram