-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 6b5e9cd
Showing
44 changed files
with
37,550 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
> 1% | ||
last 2 versions | ||
not dead |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
module.exports = { | ||
root: true, | ||
env: { | ||
node: true | ||
}, | ||
'extends': [ | ||
'plugin:vue/essential', | ||
'eslint:recommended' | ||
], | ||
parserOptions: { | ||
parser: 'babel-eslint' | ||
}, | ||
rules: { | ||
'no-console': process.env.NODE_ENV === 'production' ? 'warn' : 'off', | ||
'no-debugger': process.env.NODE_ENV === 'production' ? 'warn' : 'off' | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
.DS_Store | ||
node_modules | ||
/dist | ||
|
||
|
||
# local env files | ||
.env.local | ||
.env.*.local | ||
|
||
# Log files | ||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* | ||
pnpm-debug.log* | ||
|
||
# Editor directories and files | ||
.idea | ||
.vscode | ||
*.suo | ||
*.ntvs* | ||
*.njsproj | ||
*.sln | ||
*.sw? | ||
|
||
#Electron-builder output | ||
/dist_electron | ||
|
||
#DB files | ||
/db |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
# ChordCheet | ||
Open Source color-coded chord book that helps you keeping all your songs in a neat place! | ||
|
||
## Features | ||
- No more scrolling! All parts of a song get resized to fit on the screen | ||
- Colorful! Color-coded parts make it easy to know where you are | ||
- Dark mode! Switch to a dark version to help in dim environments | ||
- Found it! Search for a title or a song to save time | ||
- Store everything! You can also save meta data like capo placement or the bpm of your songs | ||
- For everyone! The app works on Windows, macOS & Linux | ||
|
||
## Screenshots | ||
![Main Screen](/screenshots/main_screen.png) | ||
![Add New Screen](/screenshots/addNew_screen.png) | ||
|
||
# Development | ||
This app is still in development and still has some bugs. It's also missing some features that are planned for later releases. | ||
|
||
## Known Bugs | ||
- Scaling issues depending on the length of a song | ||
- Text is not centered all the time | ||
- Some characters might not get recognized by the regex and might make some parts to not show up | ||
|
||
## Planned Features | ||
- Customizable colors | ||
- Annotations for songs | ||
- Share the active song over the local network for others to see via a link | ||
|
||
## Project setup | ||
``` | ||
npm install | ||
``` | ||
|
||
### Compiles and hot-reloads for development | ||
``` | ||
npm run electron:serve | ||
``` | ||
|
||
### Compiles and minifies for production | ||
``` | ||
npm run electron:build | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
module.exports = { | ||
presets: [ | ||
'@vue/cli-plugin-babel/preset' | ||
] | ||
} |
Oops, something went wrong.