Instructions for Local Installation

Before using Euterpe on your laptop, you'll need to complete the following steps:

1. Chrome-based browser : Even though Euterpe has been successfully tested with other browsers, we found that using chrome based browsers (Google Chrome, Chromium, Brave) gives more consistent results across various platforms.

2. Node.js : Node.js is a JavaScript runtime environment that enables Euterpe to run on your system. Please make sure you have Node.js installed.

3. Euterpe : You need to obtain the source code of the project.

4. Code Editor : Any code editor that you are familiar with (i.e VSCode, Atom, PyCharm, Notepad++ etc.)

Next, we provide both an automatic way to install Node.js and Euterpe's dependencies, as well as instructions for manual installation.

Automatic

This interactive script requires administrative or root privileges because it may need to install Node.js or nvm on your laptop. Please ensure that you have an active internet connection during the installation process.

While we've designed the script to cover most scenarios, there could be unique cases we haven't anticipated. If, for any reason, the script fails to complete the installation, we recommend following the manual installation steps as a fallback option.

For Windows Users

In order to be able to execute an external script in powershell you need to set the execution policy to 'unrestricted'.

1. open a powershell window as an administrator
2. Get your current execution policy by typing the following command (you'll need it to revert back to it)

Get-ExecutionPolicy

3. Change your policy to 'unrestricted'

Set-ExecutionPolicy Unrestricted

Now you are ready to run our script.

Don't forget to revert back to your original execution policy once you are done

powershell

# Run the following commands on a windows powershell. Execution policy needs to be set to 'unrestrictive' (check above).
# Navigate to your home folder
cd $home
# Download the script using curl (or visit the link in your browser)
curl -o install_euterpe_requirements.ps1 https://tutorial-camm-ismir23.netlify.app/install_euterpe_requirements_windows.ps1
# Run the file on the terminal
. .\install_euterpe_requirements.ps1

bash

# Navigate to your home folder
cd ~
# Download the script using curl (or visit the link in your browser)
curl -o install_euterpe_requirements.sh https://tutorial-camm-ismir23.netlify.app/install_euterpe_requirements_linux_mac.sh
# Make the script executable
chmod +x install_euterpe_requirements.sh
# Execute
./install_euterpe_requirements.sh

Manual

Details

Installing Node.js

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 -v

Based on that, you can follow one of the options below

• Install Node.js using NVM
  1. Installing NVM Instructions for MacOS, Linux and Windows
  2. Installing Node

     nvm install v20.8.1
     nvm use 20.8.1
     # verify that Node.js is correctly installed:
     node -v

• Install Node.js without NVM
  1. Choose the correct pre-build installers for your platform
  2. Or use some other package manager that your platform provides (i.e Homebrew for macOS)

Installing Euterpe

Now that you have Node.js set up, you can proceed to install Euterpe by following these steps:

• Getting the source code

  1. If you have git installed, you can clone the repo.

  git clone https://github.com/xribene/Euterpe.git

  2. If git is not available, you can download the zip version of the repo using this link

• Installing dependencies

  # Navigate to the Euterpe folder
  cd Euterpe
  # Use npm to install all dependencies
  npm install

`

Run Euterpe examples

To confirm everything was installed correctly run the following command from the Euterpe directory:

npm run dev

If successful, this command will start a local development server on port 5173. Visit http://localhost:5173 and try the deployed web-app.