git clone https://github.com/mawoka-myblock/classquiz
+ git clone https://github.com/mawoka-myblock/ClassQuiz
pipenv install
+ pipenv install -d
+ There's a small helper-script: It's called run_tests.sh and does more than
+ you think.
+
+ You can run this script with bash. It helps you managing docker-containers you need + to run ClassQuiz. The standard workflow is the following: +
+./run_tests.sh +
+ pipenv run uvicorn classquiz:app --reload --proxy-headers
+ cd frontend && API_URL=http://localhost:8080 REDIS_URL=redis://localhost:6379/0?decode_responses=True pnpm dev
+ caddy run
redis-server
- If you're done developing: ./run_tests.sh -
If you want to run all the tests: ./run_tests.sh a
/etc/hosts-file, so you can visit ClassQuiz
via test.com (Required for the Captcha and Mapbox)
127.0.0.1 test.com
+
+ Now you can visit ClassQuiz athttp://test.com:8080.
mail_servermail_portsecret_keymeilisearch_url+ You'll have to set up the storage. For developing, I'd recommend using the local + file system. to do that, set the following 2 environment-varialbes: +
+STORAGE_PATH=/tmp/storageSTORAGE_BACKEND=local+ We're using Pre-Commit for our pre-commit hooks. Install + it by running the following command: +
+pipenv run pre-commit install
+
Please use Gitmoji for your commits.
pnpm run format && pnpm run lint
IDK, just check that it works!
+Run the tests: ./run_tests.sh a