Skip to content

Latest commit

 

History

History
62 lines (43 loc) · 2.03 KB

README.md

File metadata and controls

62 lines (43 loc) · 2.03 KB

Neon v 3.1.1

Build_Status License: MIT js-semistandard-style

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 4.0 specifications.

Requirements

  • yarn:
    • brew install yarn on Mac

Setup

  1. Install the dependencies using yarn:
yarn install
  1. Build webpack:
yarn build
  1. Start the server:
yarn start
  1. Access the page at: http://localhost:8080.

Instructions

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

Test

Follow the instructions from above first. The tests for Neon use Selenium and so require a web browser (Firefox) and its driver (geckodriver). On Mac install these with Homebrew:

brew cask install firefox
brew install geckodriver

Then you can run the tests locally using yarn test. We use jest to script our tests.

These tests require the server to be running on localhost:8080

Verovio

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