README.md

The code for api.open-book.org.

Table of contents

• Requirements
• Project overview
• Contributing
  • Code of Conduct
  • License
  • Other issues
  • Git commit message conventions
• Getting started

Requirements

• Pipenv

Project overview

The project is a Django application.

Contributing

There are many different ways to contribute to the website development, just find the one that best fits with your skills and open an issue/pull request in the repository.

Examples of contributions we love include:

• Code patches
• Bug reports
• Patch reviews
• Translations
• UI enhancements

Code of Conduct

Please read and follow our Code of Conduct.

License

Every contribution accepted is licensed under AGPL v3.0 or any later version. You must be careful to not include any code that can not be licensed under this license.

Please read carefully our license and ask us if you have any questions.

Other issues

We have a keybase public channel where you can talk to us!

Git commit message conventions

Help us keep the repository history consistent 🙏!

We use gitmoji as our git message convention.

If you're using git in your command line, you can download the handy tool gitmoji-cli.

Getting started

Clone the repository

git clone [email protected]:OpenBookOrg/openbook-org-backend.git

Create and configure your .env file

cp sample.env .env
nano .env

Install the dependencies

$ pipenv install

Activate the pipenv environment

pipenv shell

Serve with hot reload at http://127.0.0.1:8000

$ python manage.py runserver

Happy coding 🎉!