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 网站，基于 WordPress.com REST API 构建。
这是我要导入的库，还是独立应用？这是一个完整的独立单页网页应用，由轻量的 Node/Express 服务器加上 React 和 Redux 前端组成，不是库或插件。确切地说，它就是 WordPress.com 登录后仪表盘背后的代码。
我要怎样在本地运行它？克隆仓库，在 hosts 文件中添加 '127.0.0.1 calypso.localhost'，然后在项目根目录运行 'yarn'，接着运行 'yarn start'，最后在浏览器中打开 calypso.localhost:3000。
开始之前需要安装什么？需要安装 git、Node.js 和 Yarn；项目在 package.json 的 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 依赖的前端库之一，用于与 WordPress.com REST API 通信，从而获取应用所需的数据。
有安全漏洞披露计划吗？有。Automattic 运行着一个专门的安全漏洞赏金网站，用于报告在 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