Skip to content
This repository has been archived by the owner on Dec 9, 2023. It is now read-only.

Commit

Permalink
Publish develop branch
Browse files Browse the repository at this point in the history
  • Loading branch information
cheap-glitch committed Jun 10, 2020
2 parents 6cc5dc0 + efb513f commit 133286b
Show file tree
Hide file tree
Showing 9 changed files with 117 additions and 26 deletions.
3 changes: 0 additions & 3 deletions .babelrc.json

This file was deleted.

2 changes: 1 addition & 1 deletion .nowignore → .vercelignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

#
# .nowignore
# .vercelignore
#

/docs/
Expand Down
12 changes: 12 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# CONTRIBUTING.md

Thank you for contributing to Fretboarder! PRs are welcomed, but please consider
**opening an issue before submitting any sizable PR**.

### Code style
* use [smart tabs](https://www.emacswiki.org/emacs/SmartTabs) (tablatures for
indentation, spaces for presentation)
* place block-opening curly quotes on their own lines (expect for objects and
CSS blocks)
* write comments and commit messages in the imperative style, with an
uppercase letter at the beginning and no full stop at the end
33 changes: 29 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,30 +9,55 @@
<img src="https://raw.githubusercontent.com/cheap-glitch/fretboarder/master/docs/screenshot-light.png" alt="A screenshot of the app in usage.">
<img src="https://raw.githubusercontent.com/cheap-glitch/fretboarder/master/docs/screenshot-dark.png" alt="A screenshot of the app in usage, with dark mode enabled.">


## Highlights

**🎸 Customize the instrument**
#### 🎸 Customize the instrument

Choose between a variety of instruments (from ukulele to 11-string guitar) and
tunings, set the length of the fretboard, and switch between left- and
right-handed fretting.

**🎨 Overlay scales and arpeggios**
#### 🎨 Overlay scales and arpeggios

The main feature that distinguishes Fretboarder from other similar apps is the
ability to display several sequences of notes on the same fretboard. You can
overlap scales and arpeggios, display their intersections and select specific
overlap scales and arpeggios, display their intersections and select specific
positions on the neck.

**💻 Use on any device**
#### 💻 Use on any device

The UI has been designed to be simple and intuitive, and to work on both desktop
and mobile devices. Dark mode included!


## Contributing

Contributions are welcomed! See [CONTRIBUTING.md](CONTRIBUTING.md).


## Supporting the app

You can support my work on Fretboarder by donating on my [Patreon](https://www.patreon.com/cheap_glitch)
or my [PayPal](https://paypal.me/CheapGlitch) page. Plenty of cool features are coming, such as:
* an audio player to listen to the scales
* a tool to help learn & practice positions
* a chord chart builder to follow along with backtracks
* and more!


## Credits & acknowledgements

The dark mode colorscheme is heavily borrowed from the [Vue Dark Mode](https://www.growthbunker.dev/vuedarkmode) project.


## License

This software is distributed under the [Mozilla Public License 2.0](https://www.mozilla.org/en-US/MPL/2.0).


## Other related tools & resources

* [All Guitar Chords](http://www.all-guitar-chords.com): a compilation of scales, chords, arpeggios, licks, and more
* [ChordMaster 2000](http://chordmaster.tardate.com): a tool to practice and memorize chords
* [ChordPic](https://chordpic.com): a chord diagram generator, with lots of options to fine-tune the looks
Expand Down
69 changes: 61 additions & 8 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
"@fortawesome/fontawesome-svg-core": "^1.2.28",
"@fortawesome/free-brands-svg-icons": "^5.13.0",
"@fortawesome/vue-fontawesome": "^0.1.9",
"@popperjs/core": "^2.4.0",
"@popperjs/core": "^2.4.2",
"core-js": "^3.6.5",
"file-saver": "^2.0.2",
"register-service-worker": "^1.7.1",
Expand Down Expand Up @@ -73,7 +73,7 @@
"sass": "^1.26.8",
"sass-loader": "^8.0.2",
"sass-mq": "^5.0.1",
"vue-cli-plugin-sitemap": "^2.1.1",
"vue-cli-plugin-sitemap": "^2.1.2",
"vue-template-compiler": "^2.6.11",
"webpack-bundle-analyzer": "^3.8.0"
}
Expand Down
2 changes: 1 addition & 1 deletion src/components/FretboardTools.vue
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ div.FretboardTools
//- Toggle fret numbers
VButton(
:icon="['fal', 'list-ol']"
icon="list-ol"
title="Show numbers"

:is-active="isShowingFretNbs"
Expand Down
4 changes: 3 additions & 1 deletion vercel.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
{
"build": {
"env": { "NPM_RC": "@npmrc" }
"env": {
"NPM_RC": "@npmrc"
}
},

"github": {
Expand Down
14 changes: 8 additions & 6 deletions vue.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -68,13 +68,8 @@ module.exports = {
'mandolin': 'pro-regular',

// Header
'twitter': 'free-brands',
'github': 'free-brands',
'paper-plane': 'pro-regular',
'heart': 'pro-regular',
'external-link-square-alt': 'pro-regular',
'sun': 'pro-solid',
'moon': ['pro-regular', 'pro-solid'],
'moon': ['pro-solid', 'pro-regular'],

// Tools & settings
'cog': 'pro-regular',
Expand All @@ -95,6 +90,13 @@ module.exports = {
'intersection': 'pro-solid',
'copy': 'pro-regular',
'times-circle': 'pro-regular',

// Footer
'twitter': 'free-brands',
'github': 'free-brands',
'paper-plane': 'pro-regular',
'heart': 'pro-regular',
'external-link-square-alt': 'pro-regular',
}
},

Expand Down

0 comments on commit 133286b

Please sign in to comment.