romm/README-DEV.md

romm

Project Setup for development

Create python virtualenv

python3 -m venv backend/venv/romm

Activate romm virtualenv

source backend/venv/romm/bin/activate

Install venv dependencies

pip install -r backend/dependencies/requirements.txt

Create environment variables file with the following variables

touch envs.env

# IGDB auth
CLIENT_ID=""
CLIENT_SECRET=""

# STEAMGRIDDB API KEY
STEAMGRIDDB_API_KEY=""

# Library path
LIBRARY_PATH="library_path/"

# DB related config
ROMM_DB_HOST=""
ROMM_DB_PORT=
ROMM_DB_ROOT_PASSWD=""
ROMM_DB_USER=""
ROMM_DB_PASSWD=""
ROMM_DB_CONFIG_PATH=""

Export environment variables

export $(cat envs.env | xargs)

Create mariadb docker container

docker-compose up -d (to your docker-compose file for run mariadb)

Install node.js dependencies

npm install

Project Testing

Activate romm virtualenv

source backend/venv/romm/bin/activate

Export environment variables

export $(cat envs.env | xargs)

Start backend API

python3 backend/src/main.py

Start frontend (compile and hot-reload)

npm run dev