Euterpe is a framework designed to bridge the gap between music interaction and creation research and its deployment into user-friendly systems accessible to the general public on the web. Euterpe aims to be a template or starting point, from which you can develop your own music interaction system.
Tip
Euterpe is currently using web features that are available only on Chrome based browsers.
We also suggest you to access the demos in incognito mode.
If you don't have node.js installed, we recommend using the Node environment manager NVM. If you already have node.js installed but it is older than v16, we suggest you install a newer one.
In your terminal, you can check if you have Node.js or NVM installed by running
# For NVM
nvm -v
# For Node
node -vBased on that, you can follow one of the options below
- Install Node.js using NVM
- Install Node.js without NVM
- Choose the correct pre-build installers for your platform
- Or use some other package manager that your platform provides (i.e Homebrew for macOS)
Now that you have Node.js set up, you can proceed to install Euterpe by following these steps:
-
Getting the source code
git clone https://github.com/xribene/Euterpe.git
-
Installing dependencies
# Navigate to the Euterpe folder cd Euterpe # Install the package manager pnpm npm install -g pnpm # Use pnpm to install all dependencies pnpm install
To confirm everything was installed correctly run the following command from the Euterpe directory:
pnpm run devIf successful, this command will start a local development server on port 5173.
Visit http://localhost:5173 and try the deployed web-app.
When you are ready to deploy Euterpe, you can run the following command in the root directory of the project:
pnpm run buildThis will by default generate a dist folder in the root directory of the project. You can then deploy the contents of the dist folder to your web server.