The Fretonator is your new interactive tool for learning common modes on the guitar, understanding the chord theory behind the modes, and most importantly - having a jam.
I am gratefully welcoming feedback from musicians, pull requests from software engineers, and anything else you are willing to contribute.
Thank you and happy jamming!
Technical
The Fretonator is built with:
Angular
Angular Universal
Angular Prerender
Netlify
The Fretonator is open source!
Want to contribute to the Fretonator? Here's now in 12 simple steps...
System requirements:
Node 14
NPM
YARN
Build Instructions
[1] Ensure Node Package Manager (NPM), Yarn and Angular CLI (NG) are installed.
npm -v
npm install -g @angular/cli yarn
[2] Fork the repository.
[3] Clone your fork to your local development environment.
git clone [url]
[4] Navigate to the Fretonator directory.
cd fretonator
[5] Install the dependencies.
yarn
[6] Run your local development server.
The --open flag opens the application in your browser automatically and is not required.
yarn start --open
[7] Navigate to http://localhost:4200/ in your browser.
[8] Write some code!
[9] Open a pull request, and I'll take a look!
[10] Things get merged.
[11] A Netlify deployment is triggered automatically.
[12] PROFIT!!!
See package.json for test and build commands available to the project.
www.fretonator.com
Other technical stuff
This project was generated using Nx.
Quick Start & Documentation
10-minute video showing all Nx features
Adding capabilities to your workspace
Nx supports many plugins which add capabilities for developing different types of applications and different tools.
These capabilities include generating applications, libraries, etc as well as the devtools to test, and build projects as well.
Below are some plugins which you can add to your workspace:
- Angular
ng add @nrwl/angular
- React
ng add @nrwl/react
- Web (no framework frontends)
ng add @nrwl/web
- Nest
ng add @nrwl/nest
- Express
ng add @nrwl/express
- Node
ng add @nrwl/node
Generate an application
Run ng g @nrwl/angular:app my-app to generate an application.
You can use any of the plugins above to generate applications as well.
When using Nx, you can create multiple applications and libraries in the same workspace.
Generate a library
Run ng g @nrwl/angular:lib my-lib to generate a library.
You can also use any of the plugins above to generate libraries as well.
Libraries are sharable across libraries and applications. They can be imported from @cheadle-farm/mylib.
Development server
Run ng serve my-app for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.
Code scaffolding
Run ng g component my-component --project=my-app to generate a new component.
Build
Run ng build my-app to build the project. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.
Running unit tests
Run ng test my-app to execute the unit tests via Jest.
Run nx affected:test to execute the unit tests affected by a change.
Running end-to-end tests
Run ng e2e my-app to execute the end-to-end tests via Cypress.
Run nx affected:e2e to execute the end-to-end tests affected by a change.
Understand your workspace
Run nx dep-graph to see a diagram of the dependencies of your projects.
Further help
Visit the Nx Documentation to learn more.
Generating WebP images
Converts Jpegs to WebP (do this before optimising jpegs)
Dependencies
- cwebp
brew install webp
cd into the images folder and run
find ./ -type f -name '*.jpg' -exec sh -c 'cwebp -q 75 $1 -o "${1%.jpg}.webp"' _ {} \;Optimising jpegs
Optimises JPEG to 75% compression
Dependencies
- jpegoptim
brew install jpegoptim
cd into the images folder and run
jpegoptim -m75 *.jpg --overwrite