withinboredom/wp-calypso

Calypso

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 https://nodejs.org plus http://expressjs.com server, https://***.github.io/react/, http://redux.js.org/, wpcom.js, and many other wonderful libraries on the front-end.

You can read more about Calypso at developer.wordpress.com/calypso.

Getting Started

Natively:

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 npm installed.
2. Clone this repository locally.
3. Add 127.0.0.1 calypso.localhost to your local hosts file.
4. Execute make run or make dashboard (for a more visually-oriented interface) from the root directory of the repository.
5. Open calypso.localhost:3000 in your browser.

Docker

1. Download and install https://docs.docker.com/engine/installation/
2. Add 127.0.0.1 calypso.localhost to your local hosts file.
3. Run docker-compose up

Some useful commands

• docker-compose up -d: Run the container in the background, you can use docker-compose logs -f to follow them on-demand
• docker-compose down: delete the container
• docker-compose down -v: delete the container and node_modules
• docker-compose run --service-ports --rm calypso make dashboard

*Note: The container uses it's own node_modules, using https://docs.docker.com/engine/tutorials/dockervolumes/, to ensure linux built **aries will work inside the container. If you need them outside the container (for editor auto-completion, etc), you'll need to run npm install outside the container.

Alternative instructions

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 [] or directly to our security bug bounty site []

Browser Support

We support the latest two versions of all major browsers, except IE, where we currently only support 11 and Edge. (see Browse Happy for current latest versions).

Troubleshooting

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

License

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