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
Что это такое?Calypso — это фронтенд для WordPress.com на JavaScript и React: переработанное одностраничное веб-приложение для чтения, написания и управления сайтами на WordPress, построенное на основе REST API WordPress.com.
Это библиотека, которую я подключаю, или отдельное приложение?Это полноценное самостоятельное одностраничное веб-приложение: легковесный сервер на Node/Express и фронтенд на React и Redux, а не библиотека и не плагин. Это буквально код, на котором работает панель управления WordPress.com для авторизованных пользователей.
Как запустить это локально?Склонируйте репозиторий, добавьте '127.0.0.1 calypso.localhost' в файл hosts, затем выполните 'yarn', а после него 'yarn start' из корня проекта, и откройте calypso.localhost:3000 в браузере.
Что нужно установить перед началом работы?Нужно установить git, Node.js и Yarn; в поле engines проекта указаны Node ^v24.15.0 и Yarn ^4.0.0.
Какие подводные камни при установке стоит знать?Перед запуском нужно вручную отредактировать локальный файл hosts, чтобы calypso.localhost указывал на 127.0.0.1. На этом шаге часто спотыкаются те, кто его пропускает.
Нужно ли запускать это самому, чтобы пользоваться WordPress.com?Нет: Calypso уже работает в основе действующей панели управления WordPress.com для авторизованных пользователей. Локальный запуск нужен в основном для разработки и участия в проекте, а для повседневного использования он не требуется.
Какие браузеры поддерживает Calypso?Поддерживаются последние две версии всех основных браузеров, поэтому работа очень старых версий браузеров не гарантируется.
Для чего нужен wpcom.js?Это одна из фронтенд-библиотек, которые использует Calypso для связи с REST API WordPress.com, откуда приложение получает данные.
Есть ли программа раскрытия информации о безопасности?Да, у Automattic есть отдельный сайт программы вознаграждений за найденные уязвимости, куда можно сообщать о проблемах безопасности в Calypso.
What are similar projects?core-js, woocommerce, wordpress-develop, js-stack-from-scratch, vue2-elm, 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 19Releasev6.15.0Jun 02
Age
10y
Commits · 90 Days