search

DDMAL / Neon

A web-based MEI neume editor.
https://ddmal.music.mcgill.ca/Neon
MIT License
25 stars 9 forks source link
javascript mei neume omr square-notation verovio

readme

Neon v6.0.0

Build_Status License: MIT dependencies Status devDependencies Status

Neume Editor ONline.

Neon is a browser-based music notation editor written in JavaScript using the Verovio music engraving library. The editor can be used to manipulate digitally encoded early musical scores in square-note notation.

Neon is a re-write of Neon.JS using a modified version of Verovio to render MEI-Neume files according to the MEI 5.0.0-dev specifications.

Neon for Artists

Neon has two main modes: viewer and editor. To learn how to use both, read the instructions on our wiki.

Neon for Developers

To Run Neon locally

Requirements

Setup

  1. Install the dependencies using yarn:

    yarn install

  2. Build webpack:

    yarn build

  3. Start the server:

    yarn start

  4. Access the page at: http://localhost:8080.

For more information, read the instructions on our wiki.

Testing

We use Cypress for E2E testing.

Run the command yarn test. Read more about testing on our wiki.

Verovio

Verovio is present as an npm package under verovio-util/verovio-dev with the name verovio-dev. Its contents come from the emscripten/npm-dev folder in a Verovio project folder.