Skip to content

Automattic/wp-calypso

Calypso

Renovate enabled

Calypso is the new WordPress front-end – a beautiful redesign of the WordPress dashboard using a single-page web application, powered by the WordPress REST API. Calypso is built for reading, writing, and managing all of your WordPress sites in one place.

beautiful screenshot

It’s built with JavaScript – a very lightnodeplusexpressserver,React.js,Redux,wpcom.js,and many other wonderful libraries on the front-end.

You can read more about Calypso atdeveloper.wordpress /calypso.

Getting Started

You can try out the user-side of Calypso onWordPress(a lot of the logged-in area is Calypso; if in doubt, view source), you can poke around the code here on GitHub, or you can install it and run it locally. The latter is the most fun.

  1. Make sure you havegit,node,andyarninstalled.
  2. Clone this repository locally.
  3. Add127.0.0.1 calypso.localhostto your localhostsfile.
  4. Executeyarnand thenyarn startfrom the root directory of the repository.
  5. Opencalypso.localhost:3000in your browser.

Need more detailed installation instructions?We have them.

Contributing

If Calypso sparks your interest, don’t hesitate to send a pull request, send a suggestion, file a bug, or just ask a question. We promise we’ll be nice. Just don’t forget to check out ourCONTRIBUTINGdoc – it includes a few technical details that will make the process a lot smoother.

Calypso welcomes – and indeed has been built by – contributors from all walks of life, with different backgrounds, and with a wide range of experience. We're committed to doing our part to make both Calypso and the wider WordPress community welcoming to everyone.

You can contribute in many ways. You can help reporting, testing, and detailing bugs, and also test new features we release in our "beta" program for testing onHorizon.

To clarify these expectations, Calypso has adopted the code of conduct defined by the Contributor Covenant. It can be read in fullhere.

Security

Need to report a security vulnerability? Go tohttps://automattic /security/or directly to our security bug bounty sitehttps://hackerone /automattic.

Our security policy can be read in fullhere.

Browser Support

We support the latest two versions of all major browsers. (seeBrowse Happyfor current latest versions).

Troubleshooting

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

License

Calypso is licensed underGNU General Public License v2 (or later).