https://github.com/openfun/warren
:bar_chart: A visualization toolkit for your learning analytics (expect some xAPI :heart:)
https://github.com/openfun/warren
analytics lrs xapi
Last synced: 10 months ago
JSON representation
:bar_chart: A visualization toolkit for your learning analytics (expect some xAPI :heart:)
- Host: GitHub
- URL: https://github.com/openfun/warren
- Owner: openfun
- License: mit
- Created: 2023-02-24T15:16:40.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-09T19:18:06.000Z (10 months ago)
- Last Synced: 2025-04-09T20:26:23.626Z (10 months ago)
- Topics: analytics, lrs, xapi
- Language: Python
- Homepage: https://openfun.github.io/warren/
- Size: 2.26 MB
- Stars: 16
- Watchers: 8
- Forks: 1
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# 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 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](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
```
## 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](https://handbook.openfun.fr).
You can ensure your code is compliant by running the following commands:
- `make lint` to run the linters
- `make test` to run the tests
Note that we also provide a git pre-commit hook to ease your life:
```
make git-hook-pre-commit
```
## License
This work is released under the MIT License (see [LICENSE](./LICENSE.md)).