ebau-gwr 0.0a0

GWR synchronisation for ebau projects

ebau-gwr

!!!WIP!!!

GWR synchronisation for ebau projects

Getting started

Installation

Requirements

• docker
• docker-compose

After installing and configuring those, download docker-compose.yml and run the following command:

docker-compose up -d

You can now access the api at http://localhost:8000/api/v1/.

Configuration

ebau-gwr is a 12factor app which means that configuration is stored in environment variables. Different environment variable types are explained at django-environ.

Common

A list of configuration options which you need

• SECRET_KEY: A secret key used for cryptography. This needs to be a random string of a certain length. See more.
• ALLOWED_HOSTS: A list of hosts/domains your service will be served from. See more.
• DATABASE_ENGINE: Database backend to use. See more. (default: django.db.backends.postgresql)
• DATABASE_HOST: Host to use when connecting to database (default: localhost)
• DATABASE_PORT: Port to use when connecting to database (default: 5432)
• DATABASE_NAME: Name of database to use (default: ebau-gwr)
• DATABASE_USER: Username to use when connecting to the database (default: ebau-gwr)
• DATABASE_PASSWORD: Password to use when connecting to database

Contributing

Look at our contributing guidelines to start with your first contribution.