Valhalla Observation Portal
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
static
templates
valhalla
.coveragerc
.dockerignore
.eslintrc.js
.gitignore
.landscape.yml
.travis.yml
CHANGELOG.md
Dockerfile
LICENSE
README.md
local_settings.sample
manage.py
package-lock.json
package.json
requirements.txt
test_settings.py
tox.ini
webpack.config.js

README.md

Valhalla Observation Portal

Build Status Coverage Status Code Health Dependency Status

Getting Started

Setting up the django backend

  1. Clone this repo
  2. ./manage.py migrate
  3. ./manage.py runserver

That's it! Check out local_settings.sample if you'd like to customize your development settings.

Setting up the frontend

We use webpack + vue.js to manage some of the more complex frontend code. Make sure you have npm installed, and in the root directory:

  1. npm install
  2. npm run watch

The last command will run a hot reload server which will automatically keep the javascript bundles up to date as you develop.

Environment variables

The default settings should be sufficient for development. Below are the list of environment variables that should be set for deployment or customization.

General

SECRET_KEY The secret key used for sessions. Default: random characters

Database

DB_ENGINE The database engine to use. Default: django.db.backends.sqlite3

DB_NAME The name of the database. Default: db.sqlite3

DB_USER The database user. Default: blank

DB_PASSWORD The database password. Default: blank

DB_HOST The database host to connect to. Default: blank

DB_PORT The database port. Default: blank

Cache

CACHE_BACKEND The django cache backend to use. Default: django.core.cache.backends.locmem.LocMemCache

CACHE_LOCATION The cache location (or connection string). Default: unique-snowflake

Email

EMAIL_HOST The SMTP host. Default: localhost

EMAIL_HOST_USER SMTP user. Default: blank

EMAIL_HOST_PASSWORD SMTP password. Default: blank

EMAIL_PORT SMTP port to use. Default: 587

External Services

ELASTICSEARCH_URL The url to the elasticsearch cluster. Default: http://localhost

POND_URL The url to the pond (http). Default: http://localhost

CONFIGDB_URL The url to configdb3. Default: http://localhost

Celery

CELERY_ENABLED Whether or not to execute celery tasks asynchronously. Default: False

CELERY_BROKER_URL The broker url for celery. Default: memory://localhost