Guitar Notes Quiz

Test your knowledge of notes on the guitar
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation & Setup
3. Usage & Demo
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

Built With

• 
• 
• 
• 

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

I am using:

• WSL 1
• Ubuntu 22.04.1 LTS (jammy)
• node v18.14.0 LTS (hydrogen)
• Visual Studio Code

• npm

  npm install npm@latest -g

Installation & Setup

1. Clone the repo

   git clone git@github.com:gregorymacat/guitarquiz.git

2. Install NPM packages

   npm install

3. Start the build

   npm run build

4. In separate terminal, start development server

   npm start

5. Navigate to http://localhost:3000

Usage & Demo

Ability to change settings letting the user choose:

• How many strings the guitar should have
• Which frets the notes will appear on/between
• How long to see feedback for correct answers

It is also possible to reset the counter with the "Reset Stats" button to get a fresh start. Otherwise, scores are tracked throughout sessions using cookies. These cookies will track settings and scores letting multiple sessions be counted together if so desired.

Make sure to save changes when finished changing settings.

Video Demonstrations

Example quiz and settings adjustments:

appdemo.small.mp4

Roadmap

See the open issues for a list of proposed features (and known issues).

Features:

• More Options
  • Tuning
  • Naturals/Accidentals Only
  • etc.
• Sounds
  • Note sound
  • Congratulatory Sound
  • etc.
• Add Bass Guitar (maybe other instruments, unlikely though)
• Timer
• Streaks
• User Accounts
  • Create user accounts
  • Save into database
  • Update stats/settings
  • Load account on login
  • Delete account if desired
• Online Competition Between Users (timed mode)
• Chord Quiz
• Probably many more!

Continuous Improvements:

• Refactor/remove redundancies, inefficiences, and nonnecessities
• Refine interface and visuals
• Increased documentation

Contributing

I would greatly appreciate any advice or criticism about this project. Feedback is welcome on any aspect of it and I appreciate anyone who took the time to read through this! I hope you have a wonderful day.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Gregory Macat - gregorymacat@gmail.com

Project Link: https://github.com/gregorymacat/guitarquiz

Acknowledgements

• https://www.flaticon.com/ (Settings Icon)