SOFTWARE-SETUP-GUIDE.md

Software setup guide

Table of Contents

• Install the required software
• Clone the repository
• Install node.js packages
• Work on a separate git branch
• Build the app
• Run localy in development mode
• After a performance

Install the required software

1. Linux

   Piece for Smartphone Orchestra is developed on a Linux environment. In particular, scripts from package.json employ bash commands. Normally, the bash shell should be part of any Linux distribution.

2. node.js (version 21.6.0)

   node.js is a JavaScript runtime environment. Prebuild binaries should be found in package repositories of the most common Linux distributions.

3. npm (version 10.3.0)

   npm is a package manager for node.js. Install it from the package repository of your Linux distribution.

4. git (version 2.43.0)

   git is a version control system. Install it from the package repository of your Linux distribution.

Optional

• SuperCollider (version 3.13.0) is an environment and programming language for audio synthesis and algorithmic composition. Install it if you would like to hear a crude approximation of the piece. In such a case, use the SuperCollider document pieceSimulation.scd. The document otoacousticEmissionTests.scd offers some simple tests on auditory distortion products.
• TeX Live is a TeX distribution. Use XeLaTeX (part of TeX Live) to render the documents pieceForSmartphoneOrchestra.tex and pieceForSmartphoneOrchestraIcon.tex. The output of the first will be the text score. The second one will produce the PWA icon of the website. Both TeX documents use the tikz package for graphics.

Clone the repository

Open a bash shell and change directory to an appropriate place. Run

git clone https://github.com/tsmtzs/pieceForSmartphoneOrchestra.git

to download the pieceForSmartphoneOrchestra repository. Change directory to pieceForSmartphoneOrchestra

cd pieceForSmartphoneOrchestra

Install node.js packages

The web application of the piece is developed with the Astro web framework. To install all the required packages run

npm install

Work on a separate git branch

For a performance it is convenient to fork off the master git branch. First, switch to master

git switch master

Then create a new branch and switch to it

git checkout -b performance@MonsAgnes

Build the app

At this step we assume that you are inside the pieceForSmartphoneOrchestra directory, have installed the necessary node.js packages and switched to a newly created git branch named performance@MonsAgnes on top of master.

Open a terminal and run the npm script build:

npm run build

This will create the directory dist. You can now deploy the app by following the deployment guide from Astro.

Run localy in development mode

With the command

npm run dev

you can run the app on a local network. The output will contain a URL of the form https://<IP>:<PORT> just after the word Network. Players can, now, open the browser and navigate to https://<IP>:<PORT>. Upon first visit, a warning like Your connection is not private or Your connection is not secure might appear. Bypass the warning by clicking Advanced and then Proceed to https://<IP>:<PORT>.

After a performance

Checkout the branch master and delete the branch of the performance

git checkout master
git branch -D performance@MonsAgnes