Skip to content

Latest commit

 

History

History
109 lines (71 loc) · 3.01 KB

README.md

File metadata and controls

109 lines (71 loc) · 3.01 KB
Raw

Joanie – Power up Richie catalog 👛

Joanie is a headless ERP for education to manage course enrollment/subscription, payment and certificates delivery.

Joanie is built on top of Django Rest Framework.

Getting started

Prerequisite

Make sure you have a recent version of Docker and Docker Compose installed on your laptop:

$ docker -v
  Docker version 20.10.2, build 2291f61

$ docker compose version
  Docker Compose version v2.25.0

⚠️ You may need to run the following commands with sudo but this can be avoided by assigning your user to the docker group.

Project bootstrap

The easiest way to start working on the project is to use GNU Make:

$ make bootstrap

This command builds the app container, installs dependencies, performs database migrations and compile translations. It's a good idea to use this command each time you are pulling code from the project repository to avoid dependency-releated or migration-releated issues.

Your Docker services should now be up and running 🎉

Note that if you need to run them afterwards, you can use the eponym Make rule:

$ make run

Adding content

You can create a basic demo site by running:

$ make demo

Now, you should be able to access the API overview interface at http://localhost:8071/api/.

Finally, you can check all available Make rules using:

$ make help

If you're preparing for production, it is recommended to host media files in an object storage. We've cooked Terraform scripts and a documentation to make it easy if, like us, you are planning to use Swift. Read more about it: docs/media.md.

If you're planning to use AWS S3 or another object storage service, please let us know by opening an issue or even better a pull request to add it to the project.

Django admin

You can access the Django admin site at http://localhost:8071/admin.

You first need to create a superuser account:

$ make superuser

Guides

Explanation

Reference

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).