Skip to content

Latest commit

 

History

History
41 lines (25 loc) · 1.85 KB

README.md

File metadata and controls

41 lines (25 loc) · 1.85 KB
Raw

WordPress.com for Desktop

WordPress.com for Desktop is an Electron wrapper for Calypso, the new WordPress.com front-end. It works on Mac, Windows, and Linux.

WordPress.com for Desktop

Getting Started & Running Locally

  1. Clone this repository locally
  2. Update the Calypso submodule with:
  • git submodule init
  • git submodule update
  1. Create a calypso/config/secrets.json file and fill it with secrets
  2. npm install will download all the required packages
  3. make build to create the builds
  4. Find the built apps in the release folder

Need more detailed instructions? We have them.

Development

The app is split between Electron code and Calypso code, and so the development guide may help you find where to change stuff.

Building & Packaging a Release

While running the app locally in a development environment is great, you will eventually need to build a release version you can share.

Contributing

If this sparks your interest don't hesitate to send a pull request, send a suggestion, file a bug, or just ask a question. Don't forget to check out our CONTRIBUTING doc.

Do be aware that this repository is just for the WordPress.com desktop wrapper. If you have something to contribute for Calypso (the app that runs inside of the desktop wrapper and on WordPress.com) then please add it in the Calypso repository.

Troubleshooting

If you have any problems running the app please see the most common issues.

License

WordPress.com for Desktop is licensed under GNU General Public License v2 (or later).