Simplenote for Electron

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

Development Requirements

• A Simperium account. Sign up here
• A Simperium Application ID and key. Create a new app here

Running

1. Clone the repo: git clone https://github.com/Automattic/simplenote-electron.git
2. Create a new file in the root directory, named config.json
3. Add the Simplenote application id and token to config.json

{
  "app_id":     "your-app-id",
  "app_key":    "yourappkey"
}

4. npm install or docker-compose up install (if Docker installed)
5. npm start or docker-compose up dev (if Docker installed)
6. Open http://localhost:4000. You can sign in to the app with your Simperium credentials.

Note: Simplenote API features such as sharing and publishing will not work with development builds.

Electron

Install electron globally npm install -g electron-prebuilt, then:

1. Run npm run build
2. Run electron .

You can also pass along the --devtools option after electron . to open the developer tools

Coding Guidelines

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

Dependencies

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