This application makes use of the core JS/CSS/HTML code found in the web repo. For issues related to the actual app experience, please post issues in the web repo.

Running Locally

npm run setup
npm run build:web # Or `npm run dev:web`
npm run dev

# In another terminal
npm start

We use commitlint to validate commit messages. Before making a pull request, make sure to check the output of the following commands:

npm run lint
npm test # make sure to start `npm run dev` before running the tests

Pull requests should target the dev branch.

Building

Build for all platforms:

electron-packager . "Standard Notes" \
  --platform=all \
  --icon=icon/icon \
  --overwrite \
  --osx-sign='Mac Developer ID Application: xxx' \
  --out=dist

or

• npm run dist

or

• npm run dist-win
• npm run dist-linux
• npm run dist-mac

Installation

On Linux, download the latest AppImage from the Releases page, and give it executable permission:

chmod u+x standard-notes*.AppImage

Alternative Downloads

The Standard Notes desktop client is also available through a variety of package managers:

• [unofficial] AUR: standardnotes-desktop, non binary package - built from source, currently maintained by danielhass