https://github.com/whitep4nth3r/fretonator
The ultimate interactive free guitar theory tool.
https://github.com/whitep4nth3r/fretonator
guitar guitar-scales guitar-tablature music music-theory
Last synced: 7 months ago
JSON representation
The ultimate interactive free guitar theory tool.
- Host: GitHub
- URL: https://github.com/whitep4nth3r/fretonator
- Owner: whitep4nth3r
- License: apache-2.0
- Created: 2020-05-17T18:16:38.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-10-25T11:34:45.000Z (almost 2 years ago)
- Last Synced: 2025-02-27T21:50:10.487Z (7 months ago)
- Topics: guitar, guitar-scales, guitar-tablature, music, music-theory
- Language: TypeScript
- Homepage: https://www.fretonator.com
- Size: 5.11 MB
- Stars: 89
- Watchers: 3
- Forks: 9
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://app.netlify.com/sites/fretonator/deploys)
---
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!
[Apache License, v2.0](https://github.com/ishythefishy/fretonator/blob/master/LICENSE)
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](https://nx.dev).
🔎 **Nx is a set of Extensible Dev Tools for Monorepos.**
## Quick Start & Documentation
[Nx Documentation](https://nx.dev/angular)
[10-minute video showing all Nx features](https://nx.dev/angular/getting-started/what-is-nx)
[Interactive Tutorial](https://nx.dev/angular/tutorial/01-create-application)
## 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](https://angular.io)
- `ng add @nrwl/angular`
- [React](https://reactjs.org)
- `ng add @nrwl/react`
- Web (no framework frontends)
- `ng add @nrwl/web`
- [Nest](https://nestjs.com)
- `ng add @nrwl/nest`
- [Express](https://expressjs.com)
- `ng add @nrwl/express`
- [Node](https://nodejs.org)
- `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](https://jestjs.io).
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](https://www.cypress.io).
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](https://nx.dev/angular) 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
```shell script
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
```shell script
jpegoptim -m75 *.jpg --overwrite
```