Note Kichen

Web app for visualizing piano chords and scales.

Getting Started

Clone the repo and open app/index.html. Production site available at http://note.kitchen.

Prerequisites

There are a few Node dependencies. Simply run npm install to load those up.

Installing

1. Run npm install
2. Develop inside the /app directory.
3. Run gulp sass to compile scss to css.

Running the tests

Open specs/specs.html in the browser to run the Jasmine tests.

Writing tests

To write tests for foo.js add specs to specs/specs/foospec.js

Deployment

1. Run gulp build.
2. The production code will be available in a new dist folder.

Built With

• Tone.js - For playing sounds
• Gulp - For workflow automation
• Jasmine - For testing

Contributing

If you have a bug fix feel free to submit a PR. For features, please look at the open Issues or contact me first with ideas. I will likely reject feature PRs unless I approved the feature ahead of time. I'm trying to keep the UI as simple as possible. Thank you!

Authors

• Nebojsa Petrovic - Initial work - nebs aka Once Upon a Synth

License

This project is licensed under the MIT License - see the LICENSE.md file for details