Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
shammy642 authored Apr 24, 2024
1 parent 045a3d3 commit 7a0b2b0
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions README.md
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.

0 comments on commit 7a0b2b0

Please sign in to comment.