Simplenote for Electron

A Simplenote React client packaged in Electron. Learn more about Simplenote at Simplenote.com.

Running

Clone the repo: git clone https://github.com/Automattic/simplenote-electron.git
cd simplenote-electron
npm install
npm run dev
The dev server will start on http://localhost:4000, and the Electron app will launch automatically.
Sign up for a new account within the app. Use the account for testing purposes only as all note data will be periodically cleared out on the server.

Note: Simplenote API features such as sharing and publishing will not work with development builds. Due to a limitation of make installation paths used for build cannot have spaces.

Building

make package-osx
make package-win32
make package-linux

Testing

Unit tests are run with npm test.

End-to-end tests are run with npm run test-e2e. Note that the Spectron version corresponds with the version of Electron we are using and so at the time of writing this is pinned at version 6. Use the corresponding API docs for webdriver-io which correspond to the Specron version. At the time of writing you will want to refer to the webdriver-io v4.13 API docs.

Coding Guidelines

Please adhere to the same guidelines as found in wp-calypso.

See CONTRIBUTING.md for more guidelines.

Dependencies

node-simperium for Simperium syncing.
ReactJS for UI.
Electron for wrapping the JavaScript application.

Simplenote for Other Platforms

simplenote-electron is the official Simplenote desktop app for Windows and Linux.

For other platforms, see: