Skip to content

KlubJagiellonski/poznaj-app-backend

Repository files navigation

Poznaj

Build Status Documentation Status Codecoverage Status Updates

This Django project includes code for backend of Poznaj Wrocław application. It tries to follow 12 Factor App Guinness.

Quickstart

Full installation instructions.

To develop locally we use docker + docker compose. First make sure that you installed docker by following these instructions: link. Then run this command to run server & apply migrations.:

$ make build
$ make run
$ make migrate

Documentation

Documentation for this project is available in the docs directory and online.

If you would like to browse the documentation locally, you can do so with sphinx:

$ git clone git@github.com:kj-wroclaw/poznaj-backend.git
$ cd poznaj-backend
$ pip install virtualenv
$ virtualenv -p /usr/bin/python3 ~/.virtualenvs/poznaj-backend
$ source ~/.virtualenvs/poznaj-backend/bin/activate
(poznaj-backend) $ pip install -r requirements/local.txt
(poznaj-backend) $ cd docs
(poznaj-backend) $ make html
(poznaj-backend) $ sphinx-autobuild . _build_html

Getting help

Use the issue tracker to follow the development conversation. If you find a bug not listed in the issue tracker, please file a bug report.

Getting involved

We welcome your feedback and contributions. See the contribution guidelines for more details.

License

  1. LICENSE

Credits

  1. Cookiecutter-django
  2. Cfgov-refresh
  3. Open-source-project-template