NACSOS Core

This repository contains the core data management platform of NACSOS. It accesses the database via the nacsos-data package and exposes the functionality via an API. It also serves the web frontend.

pg_dump -d nacsos_core -h localhost -U root -W -p 5432 > dump.sql

Installation

• Requires Python 3.10+, tested with Python 3.10.2

virtualenv venv
source venv/bin/activate
pip install -r requirements.txt

For development, it is advised to install nacsos-data locally (not from git) via

pip install -e ../nacsos-data/

(assuming both projects reside side-by-side, otherwise adapt path accordingly) If you do so, please keep in mind to update the requirements and temporarily commenting out the respective line in requirements.txt when installing the other requirements!

Running the database with docker

Start up the database by running docker (or use your local instance)

sudo systemctl start docker
docker-compose up -d

Starting the server

# set this in case you want to use a different config (optional)
export NACSOS_CONFIG=config/default.env

# for development, using the --reload option is helpful
hypercorn --config=config/hypercorn.toml --reload main:app 

The configuration is read in the following order (and overridden by consecutive steps):

1. Classes in server/util/config.py
2. .env config file (whatever is in NACSOS_CONFIG; defaulting to config/default.env)
3. Environment variables

The default config is set up to work with a locally running docker instance with its respective default config. It should never be changed, always make a local copy and never commit it to the repository!