Skip to content

Commit

Permalink
initial
Browse files Browse the repository at this point in the history
  • Loading branch information
timnehring committed Feb 12, 2022
0 parents commit 6b5e9cd
Show file tree
Hide file tree
Showing 44 changed files with 37,550 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .browserslistrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
> 1%
last 2 versions
not dead
17 changes: 17 additions & 0 deletions .eslintrc.js
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'
}
}
29 changes: 29 additions & 0 deletions .gitignore
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
42 changes: 42 additions & 0 deletions README.md
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
```
5 changes: 5 additions & 0 deletions babel.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
module.exports = {
presets: [
'@vue/cli-plugin-babel/preset'
]
}
Loading

0 comments on commit 6b5e9cd

Please sign in to comment.