Fonzie’s project has been designed with “container-native development” in mind. In this guide, we will consider that your are familiar with Docker and its ecosystem.
As you might already have expected, we extensively use Docker (17.12+) and Docker compose (1.18+) in our development workflow. So, if you intend to work on Fonzie, please, make sure they are both installed and functional before pursuing this guide.
First things first, to start contributing on the project, you will need to clone Fonzie’s repository and then build the Docker-based development stack with:
# Clone Fonzie's repository
$ git clone git@github.com:openfun/fonzie.git
# Build required containers
$ make bootstrap
The make bootstrap command will:
edx-platform Docker image with Fonzie installed and configured,Fonzie’s API should be accessible from: http://localhost:8072/api/v1.0/
We invite you to test the status/version endpoint to ensure everything went
well:
$ curl http://www.mydomain.com:8080/api/v1.0/status/version
{"version":"0.4.0"}
If you use to work with Django’s development server, you will have the same
experience with a Docker-based development stack: Fonzie is installed in edit
mode and mounted as a volume in the lms service. Combined with the
development server, the application will be reloaded when the source code
changes.
If your work on Fonzie requires new dependencies, you will need to:
options.install_requires section of the setup.cfg file (or
the options.extras_require.[dev,doc,...] section if it’s a development
dependency),lms service image via the make build utility.$ make migrate