diff --git a/README.md b/README.md index c01978c..627bb81 100644 --- a/README.md +++ b/README.md @@ -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. \ No newline at end of file +4. Access http://localhost:3000/ on your browser.