# valhalla

**Repository Path**: cucy/valhalla

## Basic Information

- **Project Name**: valhalla
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2017-07-25
- **Last Updated**: 2020-12-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Valhalla Observation Portal
[![Build Status](https://travis-ci.org/LCOGT/valhalla.svg?branch=master)](https://travis-ci.org/LCOGT/valhalla)
[![Coverage Status](https://coveralls.io/repos/github/LCOGT/valhalla/badge.svg?branch=master)](https://coveralls.io/github/LCOGT/valhalla?branch=master)
[![Code Health](https://landscape.io/github/LCOGT/valhalla/master/landscape.svg?style=flat)](https://landscape.io/github/LCOGT/valhalla/master)
[![Dependency Status](https://www.versioneye.com/user/projects/589df7f4940b230036768664/badge.svg)](https://www.versioneye.com/user/projects/589df7f4940b230036768664)

## 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](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`