matevz / notecheck

Solfege exercises

NoteCheck

A simple django app for solfege exercises.

Currently supported exercises:

• name note pitch (treble or bass clef, optional sharps and/or flats) in English/Slovenian/German language
• name interval between the notes (quantity, quality+quantity, number of fulltones and/or semitones) in English/Slovenian language
• write down scales (major/minor, natural/harmonic/melodic)

Installation and Quickstart

NoteCheck is a simple django app. It was tested with Django 3.2.6 and Python 3.8 on Ubuntu 20.04.

To setup the app locally:

1. git clone https://github.com/matevz/notecheck.git; cd notecheck
2. export SECRET_KEY=some_secret_key
3. ./manage.py migrate
4. ./manage.py compilemessages # Localization.
5. ./manage.py createsuperuser # Add at least one admin user.
6. DEBUG=1 ./manage.py runserver
7. Teacher visits http://localhost:8000/admin, logs in and adds an exercise. Shares the public exercise link (http://localhost:8000/<exercise token>) to the student, e.g. http://localhost:8000/6d9b478d-e646-4614-8a95-9b73ece071a0.
8. Student visits the link and solves the exercise.
9. Teacher can view the submissions in the admin view http://localhost:8000/admin/notecheck/submission/.

Application settings (language, timezone etc.) are located in notecheckproject/settings.py.

notecheck's Issues

Show exercise name and description

When solving the submission it would make sense to put the title of the current exercise and what your goal is (syntax of the note pitches etc.).

Add support for interval exercises

Implement:

• Interval model (see implementation in Canorus)
• IntervalExercise consisting of bunch of note pairs for which a student needs to compute an interval

NotePitchExercise: Add responsive html

Currently the questions are float:left but the width of the form seems to be fixed to 960px. Horizontal scrollbars are used on mobile devices instead of showing a single or at most two questions per screen. Figure out why the responsive design doesn't work.

NotePitchExercise: Add typo check

Add pattern attribute to input fields which avoids common typos and expects something like (a-h)[aeis]*[1-5]|(A-H)[aeis]*[12] (not tested).

Intervals: Always show second accidental for prime

Currently, des - d is shown as des and d (without natural). Add natural to second note, if sharp or flat is present for prime intervals.

Add integration tests

Add an integration test which creates an exercise and solves it.

Add landing page

Figure out what to put to landing page. Maybe just redirect to admin/?

Add favicon

Add favicon.ico and fix routing accordingly

Add CI

Add CI which runs manage.py test and add a badge to readme.

Show sports car, if best time achieved

Show a racing car 🏎 drving from the right to left and back (CSS-only), if best time was achieved.