How to contribute

Setup

You can help contributing to BoostNote.next by following these steps:

Make sure you have a working installation of npm and git. Run npm -v and git --version to verify this.

1. Fork this project.
2. Clone your fork into an empty directory with git@github.com:<your_username>/BoostNote.next.git
3. Create an empty file called .env in this root directory.
4. Install dependencies by running npm i in this directory.

You can now start making changes to the code. This is a good point to look through open issues.

Build Web app

Run npm run dev and then wait for your default browser to open with your build.

Build Electron app

WIP

Submit your changes

Submit a PR with your changes, and wait for it to be reviewed. Make any changes if needed and it will be merged. And that's it!

Thanks for your contribution! <3