Development-setup

Requirements

Backend

• Python
  I just plan to support the most recent version of Python.
  At least Python 3.10
• Caddy
• Pipenv
• Redis
• Meilisearch
• (Optional) Caddy

Frontend

• pnpm

Setup

• Clone the repo:

  git clone https://github.com/mawoka-myblock/classquiz

• Install the dependencies
  • Python:

    pipenv install

  • JS:

    cd frontend && pnpm i

• Start the other services
  • Caddy:

    caddy run

  • Redis:

    redis-server

• Set your config up in your .env-file. What you have to set up can you see in the classquiz/config.py-file. The things you have to set are the following:
  • hcaptcha_key
  • mail_address
  • mail_password
  • mail_username
  • mail_server
  • mail_port
  • secret_key
  • meilisearch_url
• Start the server
  • Backend:

    pipenv run uvicorn classquiz:app --reload

  • Frontend:

    cd frontend && pnpm dev

BEFORE you submit a Pull-Request

Please use Gitmoji for your commits.

Frontend

Please format and lint your code with

pnpm run format && pnpm run lint

Backend

IDK, just check that it works!