README.md

Overview

• Overview
• Installation
  • Setting up the .env file
  • Installation using Docker Containers
  • Native Installation
    • Django
    • React
• Running the ELN instance
  • Docker
    • Running a frontend development server
    • Stop running the instances

Installation

Setting up the .env file

# .env
SECRET_KEY='<secret_key>'
DEBUG=False
ALLOWED_HOSTS='<allowed_host>, ...'

TIME_ZONE='Europe/Berlin'

POSTGRES_DB='flask_database'
POSTGRES_USER='admin'
POSTGRES_PASSWORD='<admin_password>'

#CORS_ALLOW_ALL_ORIGINS=True
CORS_ALLOWED_ORIGINS='<allowed_origins>, ... '

Installation using Docker Containers

Install prerequisites:

• docker

Native Installation

Install prerequisites:

• conda
• npm (node.js)

Django

Setting up the environment:

conda install -f environment.yml
conda activate flask

React

In the frontend/ directory, run:

npm install

Running the ELN instance

Docker

docker compose up -d --build

or with a respective .env file:

docker compose --env-file .env up -d --build

Running a frontend development server

In frontend/, run:

npm run dev

Stop running the instances

docker compose down