Local Install (without Docker)

This guide will walk you through setting up Janeway locally without docker on Ubuntu. For development we recommend Docker, however. This document assumes you are using and have setup Postgres which is our recommended SQL server. There is a decent guide here: https://www.digitalocean.com/community/tutorials/how-to-install-and-use-postgresql-on-ubuntu-18-04

Initial Setup

1. Install requirements: sudo apt-get install git python3.8-venv python3-wheel libxml2-dev libxslt1-dev python3-dev zlib1g-dev lib32z1-dev libffi-dev libssl-dev libjpeg-dev g++ libpq-dev.
2. Create a venv python3 -m venv /path/to/venv/folder/janeway.
3. Clone the Janeway repository.
4. Navigate to the Janeway root directory of the Janeway repository.
5. Install pip wheel pip3 install wheel
6. Install pip requirements pip3 install -r requirements.txt
7. If this is a development environment also install dev-requirements pip3 install -r dev-requirements.txt
8. Create a settings.py file in /path/to/janeway/src/core/. You'll need to setup the database connection. Here is an example:

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.postgresql',
        'NAME': 'janeway',
        'USER': 'janeway',
        'PASSWORD': 'janeway',
        'HOST': 'localhost',
        'PORT': 5432,
    }
}

8. For this example I setup a database called janeway, added a user called janeway and set its password as janeway.