Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

Windows install part A (checked on Windows 10 and 11)

1. Install scoop, (a command-line installer for Windows). Open a PowerShell terminal (as user - NOT admin. The prompt should be your username NOT Windows32) and execute the following commands (one at a time):

   A) Install Scoop

   Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser

   WARNING - If it asks you to confirm Y/N at this point you need to restart PowerShell as user NOT administrator.

   Invoke-RestMethod -Uri https://get.scoop.sh | Invoke-Expression

   B) Install Git

   scoop install git

   C) Install poetry

   scoop install main/poetry

   D) Uninstall incorrect version of python

   scoop uninstall python

   E) Install correct python version

   scoop install python@3.11.6

   F) Install Fluidsynth

   scoop bucket add extras

   scoop install extras/fluidsynth

   G) Add Fluidsynth to PATH (NB It may have automatically done this.)

   Add the C:\Users\me\scoop\apps\fluidsynth\current\bin subdirectory to your PATH (change 'me' to your username) . To do this, click in the search box on the task bar, run the command 'Edit the system environment variables', click 'Environment Variables…', select Path in the 'User variables' section, click 'Edit…', click New, then enter the path of the bin subdirectory, e.g. C:\Users\me\scoop\apps\fluidsynth\current\bin (change 'me' to your username) . )

–––––––––––––––––––––

MacOS install part A

1. Install HomeBrew. Follow instructions at: https://brew.sh/
2. Install Fluidsynth in HomeBrew

   brew install fluidsynth

–––––––––––––––––––––

Install part B (ALL PLATFORMS: Windows 10 & 11, Linux and MacOS)

1. Open a Terminal window (Mac & Linux) or a Command Prompt (Windows: in the toolbar search type 'command prompt', and open as user).

2. Clone the repo

   git clone https://github.com/DigiScore/joyinst.git

3. Navigate to the folder

   cd joyinst

4. Install the dependencies (one at a time)

   poetry shell

   poetry install

5. Close the Terminal window

–––––––––––––––––––––

Running the app (ALL PLATFORMS)

1. Open a new Terminal window (Mac & Linux) or a Command Prompt (Windows: in the toolbar search type 'command prompt', and open as user).

2. Navigate to the folder

   cd joyinst

3. Activate poetry

   poetry shell

4. Enter the main APP folder

   cd joyinst

5. Execute the code

   poetry run python main.py

–––––––––––––––––––––

Updating the software (ALL PLATFORMS)

1. Open a new Terminal window (Mac & Linux) or a Command Prompt (Windows: in the toolbar search type 'command prompt', and open as user).

2. Navigate to the folder

   cd joyinst

3. Update from the Git

   git pull