The frontend uses React and Next.js.
To run the code quality checks please run the following command from the folder frontend/
, after having installed the frontend:
yarn lint
To run the unit tests please run the following command from the folder frontend/
, after having installed the frontend:
yarn test
End to end tests let us test a small number of functionnalities implying the frontend, the backend, and a real chromium browser on which the user activity is simulated.
The tests are launched from frontend/
repository and use CodeceptJS.
To run the tests, please run the following command:
yarn end_to_end
The backend will run on 3501 port, and the frontend on 3502, and a new database will be created for end to end tests at backend/end_to_end_db.sqlite3
.
The browser will be launched in graphical mode, and will be visible throughout the tests. To run the tests in headless mode you can add the CI
environment variable:
CI=1 yarn end_to_end
The documentation uses jsdoc. To generate the documentation, please run the following command:
yarn docs
The documentation will then be available as html in the directory frontend/docs/
.