warren-api

The visualization platform for your learning analytics (API backend)


Keywords
Analytics, xAPI, LRS, LTI
License
Other
Install
pip install warren-api==0.1.0

Documentation

Warren

Warren is a visualization platform for learning analytics.

⚠️ This project is a Proof Of Concept not suitable for production yet. ⚠️

Quick start guide (for developers)

Once you've cloned the project, it can be bootstrapped using the eponym GNU Make target:

$ make bootstrap

Once frontend and backend Docker images have been built, you can start the backend and frontend development servers using:

$ make run

You may now take a look at the frontend development server at: http://localhost:3000

To run tests and linters, there are commands for that! You can list them using:

$ make help

Contributing

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.

License

This work is released under the MIT License (see LICENSE).