Warren is a visualization platform for learning analytics.
Once you've cloned the project, it can be bootstrapped using the eponym GNU Make target:
$ make bootstrap
Once frontend and API backend Docker images have been built, you can start the API backend and frontend development servers using:
$ make run
You may now take a look at the frontend development server at: http://localhost:8090/development
Click on Submit Query and scroll down to get the development LTI iframe rendering.
To run tests and linters, there are commands for that! You can list them using:
$ make help
This project is intended to be community-driven, so please, do not hesitate to get in touch if you have any question related to our implementation or design decisions.
We try to raise our code quality standards and expect contributors to follow the recommandations from our handbook.
You can ensure your code is compliant by running the following commands:
make lintto run the lintersmake testto run the tests
Note that we also provide a git pre-commit hook to ease your life:
make git-hook-pre-commit
This work is released under the MIT License (see LICENSE).
![@renovate[bot]](https://avatars.githubusercontent.com/in/2740?s=64&v=4){kind=small}
