beacon-gamification-backend

Backend code for the beacon project.

Table of contents

• Gettings started
• Running tests
• Deployment
• Docker environment
• Information

Getting started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

To build the project, the following prerequisites must be met:

• Python 3.6 and up

Other used technologies

• SQLite.

Source code

Get a copy of the repository:

git clone https://github.com/noi-techpark/beacon-gamification-backend.git

Change directory:

cd beacon-gamification-backend/

Install python dependencies

Create a virtualenv:

python3 -m venv env

Activate the virtualenv:

source env/bin/activate

Install dependencies:

pip install -r requirements.txt

Development

After the installation of dependencies you can follow the Django documentation. Use the standard development server with python project/manage.py runserver.

Deployment

ToDo: A detailed description about how the application must be deployed.

Information

Support

For support, please contact [email protected].

Contributing

If you'd like to contribute, please follow the following instructions:

• Fork the repository.

• Checkout a topic branch from the development branch.

• Make sure the tests are passing.

• Create a pull request against the development branch.

Documentation

More documentation can be found at https://opendatahub.readthedocs.io/en/latest/index.html.

License

The code in this project is licensed under the GNU AFFERO GENERAL PUBLIC LICENSE Version 3 license. See the LICENSE.md file for more information.