Setup & Requirements

Setting up requires access to the X-System repository. Please reach out to X-System to get access.

For the sake of convenience, instructions are below.

MuseIT Co-Creation Platform

Download and install python 3.10 or above from https://www.python.org/.

Download and install latest LTS version of Node (currently 20.12.1).

Install yarn: - Run cmd/powershell as admin - Run corepack enable - Close the admin shell

Make and activate a virtualenv then run:

cd backend
pip install -r requirements.txt
pip install -e .

You'll also need to make sure you have yarn installed and run:

cd frontend
yarn install

Then you can run everything with:

python -m museit_backend

The backend process will spawn the frontend for you.

If you want hot-reloading for the python code during development install jurigged:

pip install jurigged

Then you can run the app with:

jurigged --watch [path to backend] -m museit_backend

The backend services can be run with either docker compose, or podman compose.

First change to the backend directory:

cd backend

Build the services if necessary:

docker compose build

Then run them:

docker compose up -d

If you only want to run a single service (eg musicgen) you can run it with:

docker compose up -d musicgen