-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
14 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,20 @@ | ||
# MusicTheory | ||
Visual music theory exercises. | ||
Visual music theory exercises, for beginners. | ||
|
||
Frontend developed with React, Material UI and written in Typescript. | ||
Backend developed in NodeJS with Express and uses Sequilize for database management. | ||
|
||
## Features | ||
|
||
- Interactive piano UI. | ||
- Two types of excercises. | ||
- User's can register and login to save their progress. | ||
- Back-end driven. Excercises are stored on the database, and dynamically displayed on the front-end. | ||
- Robust, redux-like state management for user authorisation, excercises, and the users progress. | ||
|
||
|
||
## Installation | ||
1. Make sure you have the latest version of Docker Desktop installed. | ||
2. Clone this repository | ||
3. Run `docker-compose up --build` from the root of the directory. | ||
4. Access http://localhost:3000/ on your browser. | ||
4. Access http://localhost:3000/ on your browser. |