https://github.com/mikehadlow/gtr-cof

Interactive music theory dashboard for guitarists. http://guitardashboard.com/
https://github.com/mikehadlow/gtr-cof

d3 d3js guitar music-composition typescript

Last synced: 19 days ago
JSON representation

Interactive music theory dashboard for guitarists. http://guitardashboard.com/

• Host: GitHub
• URL: https://github.com/mikehadlow/gtr-cof
• Owner: mikehadlow
• License: mit
• Created: 2016-10-10T12:37:16.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2022-11-23T12:35:28.000Z (about 2 years ago)
• Last Synced: 2024-04-14T19:04:36.286Z (8 months ago)
• Topics: d3, d3js, guitar, music-composition, typescript
• Language: TypeScript
• Homepage:
• Size: 977 KB
• Stars: 324
• Watchers: 23
• Forks: 66
• Open Issues: 24
• Metadata Files:
  • Readme: README.md
  • Funding: FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Guitar Dashboard

An interactive music theory dashboard for guitarists. http://guitardashboard.com/

The aim is to provide a graphical representation of music theory elements (scales, modes, chords etc) mapped to a guitar fretboard.

## Developing with VS Code

Guitar Dashboard is written in Typescript using VS Code. Make all code changes in the src/*.ts files. Compilation outputs to the docs folder, do not edit the *.js or *.js.map files in this directory. They are included in the source repository because the website is hosted in GitHub pages which does not support Typescript compilation.

1. Clone or fork-and-clone this repository.

2. File -> Open folder at the root directory of the cloned repository.

4. To develop locally using lite-server:

    - npm install

    - npm start

5. Browse to http://localhost:10001/

6. Edit the src/*.ts, index.html and gtr-cof.css files.

8. Commit, push to GitHub and create a pull request :)

## Developing without VS Code

First, make sure you have TypeScript installed. If not, `npm install -g typescript` will do the trick.

1. Clone the repo and go into it

2. Run `npm install`

3. Open a shell and run `tsc --watch` so that the sources are always rebuilt automatically on source changes

4. Open another shell and run `npm start` in it so that results will be visible in a browser

5. Browse to http://localhost:10001/

6. Edit the src/*.ts, index.html and gtr-cof.css files.

7. Commit, push to GitHub and create a pull request :)