fonzie 0.5.0

A FUN API for Open edX

This project is in early-development phase, we are still experimenting on it. It 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.

Overview

Fonzie is an HTTP API over the Open edX project. It has been build to open the way to new tools and interfaces in the Open edX ecosystem.

We choose to design the API first and then propose an implementation with Fonzie. The current state of the API schema is available in API blueprint format; it can be used to start developing a front-end application that will consume Fonzie’s API (take a look at API blueprint tools).

Documentation

The full documentation is at https://fonzie.readthedocs.org.

License

The code in this repository is licensed under the AGPL 3.0 unless otherwise noted.

Please see LICENSE.txt for details.

How To Contribute

Contributions are very welcome.

Even though they were written with edx-platform in mind, the guidelines should be followed for Open edX code in general.

PR description template should be automatically applied if you are sending PR from github interface; otherwise you can find it it at PULL_REQUEST_TEMPLATE.md

Issue report template should be automatically applied if you are sending it from github UI as well; otherwise you can find it at ISSUE_TEMPLATE.md

Reporting Security Issues

Please do not report security issues in public. Please email [e-mail].

Getting Help

Have a question about this repository, or about Open edX in general? Please refer to this list of resources if you need any assistance.