/HarmonyLab

Harmony Lab is an application for music theory students, faculty, and staff in higher ed or K-12 who are learning to read and write music or who are instructing students in reading and writing music.

Primary LanguageJavaScriptBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

Build Status

Overview

HarmonyLab is an Open-Source application for students of music theory and keyboard skills at college or in K-12. It works with input from a MIDI keyboard in a web browser to provide simple practice aids and exercises for learning tonal harmony. By bringing together tactile, visual, and aural elements, this software helps students to build a robust and ready knowledge of the fundamentals of melodic and harmonic grammar.

Working with the input from a MIDI keyboard (subject to key and key signature selections), the application notates pitch elements and provides various analytical notations for melody and harmony.

Demo: https://harmonylab.herokuapp.com/

Quickstart

$ git clone git@github.com:Harvard-ATG/HarmonyLab.git harmony
$ cd harmony
$ pip install -r requirements.txt
$ ./manage.py runserver

You should now be able to run the application on your localhost at http://127.0.0.1:8000.

Supported Web Browsers

Chrome is currently the only browser supported, being the single browser that implements the WebMIDI specification.

Heroku Deployment

This application can be deployed to any platform that supports python and django. One such example is heroku, a cloud platform as a service provider, which makes it easy to deploy changes directly from the git repository.

Read the Getting Started on Heroku with Python instructions to get an idea of how it works. You will need to setup an account login and then create an "app".

The required Config Variables that should be added on the app settings page are as follows:

SECRET_KEY = YOUR_RANDOM_LONG_PASSWORD
DJANGO_SETTINGS_MODULE = harmony.settings.heroku
LTI_OAUTH_CREDENTIALS = {"harmonykey":"harmonysecret"}

In the root directory of the git repo, use the heroku CLI to login and then deploy the code to heroku:

$ heroku login
$ git push heroku master

If the build succeeded, you should be able to visit the webpage of the app. Heroku provides a handy shortcut:

$ heroku open