Local development guide

[Ohlisp]

Local development quick guide (including workaround for current issues

This is a guide to run the whole application partially

Prequisite

Install Docker, poetry, pyenv ( or other that could manage python version), nvm.

specify the python version

If you are using pyenv, then

pyenv local 3.10

in the root folder of the project, as newer version of python such as 3.13 will not work properly with the dependencies.

Then follow the installation step in README. NOTE: the docker-compose.yml is not working currently, please only do docker compose up redis postgres -d.

To OMR Tool Backend service, if you cannot start with the command provided in the document, usepoetry run python -m app instead.

Some workarounds

Currently the signup page is broken, so many setup has to do modification to the database directly.

Once you create the user, regardless the error of showing in the frontend, check the database.
Then, change the role and email_verified in the user model table accordingly.

Another way is to insert seed data by accessing localhost:3001/api/v1/seed. View the accessible user in backend/src/modules/seed/seed.controller.ts