chordbook / onsong

A JavaScript library for parsing and formatting chord sheets in the OnSong File Format.

Chord sheets and tab for guitar and ukulele.
chordbook.app

Contribute

Chord Book is made by volunteers. Any contributions you make are greatly appreciated, including feedback, feature requests, code, or anything else you have to offer.

If you are looking for ways to contribute, here are a few places to start:

1. Review the roadmap
2. Browse discussions or start a new one
3. Browse open issues or open a new one.

Development

This app is built using Ruby on Rails for the backend API and Vue.js, Ionic, and Tailwindcss for the client.

If you would like to contribute code:

1. Fork the repository on GitHub and clone a local copy
2. Get the app running locally by running these commands from your terminal:

   $ bin/setup
   $ bin/dev
   

3. Create your feature branch (git checkout -b my-amazing-feature)
4. Make your changes and run the tests (bin/test)
5. Commit your Changes (git commit -m 'Add some my-amazing-feature)
6. Push to the branch (git push -u origin my-amazing-feature)
7. Open a Pull Request

License

This project is licensed under the MIT License

onsong's Issues

Missing grammar.js (not compiled)

If you install this package, it doesn't come with the grammar.js needed to run. I had to build it manually with npx peggy node_modules/onsong/src/grammar.peggy. Makes sense you don't want to version control it, but when deploying to npm, I think it should be included.

P.S. Thanks for making this - I needed a parser and glad not to have to build my own! And it helped me find ChordBook, which is a nice alternative to a certain other website with annoying ads :D