The chapters new and improved songbook (PWA) webapp!
This project is built with Vite as a React + TypeScript web-app using Yarn Classic as the package manager.
yarn install # install dependencies
yarn dev # start local serverPWA features don't work when running yarn dev so to test something dependant on this you have to run:
yarn build
yarn startAll contributions are welcome! But to maintain code readability and make contributions as easy as possible please follow these guidelines.
Code style is maintained using Prettier and the rules provided in .prettierrc
There are two commands to use prettier from the terminal
yarn lint # validates code styling
yarn format # formats codeTo keep track of what work needs to/should be done, what is being done and what has been done we use the issues on GitHub.
All commits should include either Related to #X to or Resolves #X in the commit message. As in the following example:
Add some feature
Add this
Remove that
Update something
Resolve #13
This is done to make reading the history easy and understanding what the purspose of each commit was.
All changes should include an update to the changelog and a version bump. The format on the changelog is based on Keep a Changelog, and adheres to Semantic Versioning.
The only time where a version bump should not take place is when the additions/updates are hidden (e.g. a view that is not accessable).
Keep the history simple and clean. Try to keep it to one commit for one issue, if you feel like it's getting too big, then the issue is probably too big – split it up!
Deployment is automatically managed by GitHub workflows.