wp-calypso README

The project's README from github.com/Automattic/wp-calypso. As one markdown file: README.md.

Calypso

Renovate enabled

Calypso is the new WordPress.com front-end – a beautiful redesign of the WordPress dashboard using a single-page web application, powered by the WordPress.com 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 light node plus express server, React.js, Redux, wpcom.js, and many other wonderful libraries on the front-end.

Getting Started

You can try out the user-side of Calypso on WordPress.com (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 have git, node, and yarn installed.
  2. Clone this repository locally.
  3. Add 127.0.0.1 calypso.localhost to your local hosts file.
  4. Execute yarn and then yarn start from the root directory of the repository.
  5. Open calypso.localhost:3000 in 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 our CONTRIBUTING doc – 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 on Horizon.

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

Security

Need to report a security vulnerability? Go to https://automattic.com/security/ or directly to our security bug bounty site https://hackerone.com/automattic.

Our security policy can be read in full here.

Browser Support

We support the latest two versions of all major browsers. (see Browse Happy for current latest versions).

Troubleshooting

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

License

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

wp-calypso (Automattic/wp-calypso)

Searching Database…

12.6K ·GitHub
Wp-calypso
What is this?Calypso is the JavaScript and React-powered front-end for WordPress.com — a redesigned single-page web app for reading, writing, and managing WordPress sites, built on top of the WordPress.com REST API.
Is this a library I import, or a standalone app?It's a full standalone single-page web application — a lightweight Node/Express server plus a React and Redux front-end — not a library or plugin. It's literally the code behind the logged-in WordPress.com dashboard.
How do I get it running locally?Clone the repo, add '127.0.0.1 calypso.localhost' to your hosts file, then run 'yarn' followed by 'yarn start' from the project root, and open calypso.localhost:3000 in your browser.
What do I need installed before I start?You need git, Node.js, and Yarn installed; the project specifies Node ^v24.15.0 and Yarn ^4.0.0 in its engines field.
Any install pitfalls I should know about?You must manually edit your local hosts file to point calypso.localhost to 127.0.0.1 before it will run, which trips up people who skip that step.
Do I need to run this myself to use WordPress.com?No — Calypso already powers the live, logged-in WordPress.com dashboard; running it locally is mainly for development and contribution, not required for everyday use.
Which browsers does Calypso support?It supports the latest two versions of all major browsers, so very old browser versions are not guaranteed to work.
What is wpcom.js used for?It's one of the front-end libraries Calypso relies on to talk to the WordPress.com REST API that powers the app's data.
Is there a security disclosure program?Yes, Automattic runs a dedicated security bug bounty site for reporting vulnerabilities found in Calypso.
What are similar projects?core-js, woocommerce, wordpress-develop, vue2-elm, js-stack-from-scratch, docs, react-redux-links, 30-Days-Of-JavaScript
Which topics is it in?es6-javascript, es2015, single-page-app, wordpress, es6, redux, gplv2, node, php, github-actions, ci, rest-api
Creator
Automattic
Size
1 GB
Stars
12.6K
Updated
CommitOct 16Releasev6.15.0Jun 02
Age
10y
Commits · 90 Days