romm/README.md

romm

Project Setup

Create python virtualenv

python3 -m venv backend/venv/romm

Activate romm virtualenv

source backend/venv/romm/bin/activate

Activate romm virtualenv

pip install -r backend/dependencies/requirements.txt

Create environment variables file with the following variables

touch backend/envs.env

# IGDB auth
CLIENT_ID=""
CLIENT_SECRET=""

# STEAMGRIDDB API KEY
STEAMGRIDDB_API_KEY=""

# Platforms system path
PLATFORMS_SYSTEM_BASE_PATH="mock/emulation"

# DB related config
ROMM_DB_HOST=""
ROMM_DB_PORT=
ROMM_DB_ROOT_PASSWD=""
ROMM_DB_USER=""
ROMM_DB_PASSWD=""
ROMM_DB_CONFIG_PATH="../../backend/database/mariadb/config"

Export environment variables

export $(cat backend/envs.env | xargs)

Create mariadb docker container

docker-compose -f backend/database/docker-compose.yml up -d

Install node.js dependencies

npm install

Project Testing

Activate romm virtualenv

source backend/venv/romm/bin/activate

Export environment variables

export $(cat backend/envs.env | xargs)

Start backend API

python3 backend/src/main.py

Start frontend (compile and hot-reload)

npm run dev