Sonic-Pi-Web is a collaborative environment for Sonic Pi. It allows multiple users edit the same file in real time.
-
Make sure you have Node installed.
-
Clone the repository.
-
Inside the root directory run
npm installto install dependencies. -
Install Etherpad-lite.
-
Install Sonic Pi.
- Note: Recent updates moved some files in Sonic Pi, which makes sonic-pi-tool fail to locate things properly; for now, is best to use a Sonic Pi version before 3.2.
-
Install sonic-pi-tool.
-
Run your instance of Etherpad-lite. A key will be generated in
APIKEY.txt. -
Copy this key to the file
/modules/etherpad-api.example.js. For the tests to work, its also necessary to copy the key to/test/3_etherpad-lite.js -
Either make a copy of this file and remove the
.example, or just remove it from the original.
-
Run Etherpad-lite.
-
Run Sonic Pi through sonic-pi-tool:
sonic-pi-tool start-server. -
Run the application either with:
DEBUG=sonic-pi-web:* npm startor justnpm start.
The app integrates different technologies to achieve the collaboration of multiple users in real time, editing the same document of Sonic Pi.
The core app, the logic, is built in Node JS, using the express web framework.
Socket.io is used to fire and listen for some events, like playing or stopping the current file being edited, and making the server respond acordingly.
Etherpad-lite is the service that allows multiple users edit the same file in real time. Its pads are embbeded in the web app, where users write the code to be interpreted.
Sonic Pi needs to be there so the files are ran through its server; its being used as the interpreter.
Allows controlling Sonic Pi from the command line. Using the commands available is how the code in the pads from the app are passed to Sonic Pi to interpret.
Skeleton provides a CSS bolierplate that is expanded a bit for the UI of the app.
Used to embed the pads and interact with the Socket.io client in the pages of the app.