Skip to content
This repository has been archived by the owner on Jun 16, 2020. It is now read-only.

Automattic/rest-api-console2

Repository files navigation

Console2

A better REST console.

This project has been superceded by https://github.com/Automattic/wp-api-console, which now powers the API console at developer.wordpress.com.

Development

Hacking requires node.js, install node.js for your system. (e.g. brew install node).

To get up and running:

  1. Clone the repository git clone https://github.com/Automattic/rest-api-console2.git

  2. Install dependencies npm install

  3. Run the dev server npm start

Visit http://localhost:4000 in your browser.

Tip: You can change the port using the PORT environment variable:

sudo PORT=80 npm start

WordPress.com's app settings do not allow CORS URI's with ports in them.

Configure

Visit WordPress.com Developer Resources and create an application.

Copy config.sample.json to config.json and use your WordPress.com App ID and Redirect URI for the values.

You will also need to add your host to the CORS whitelist in the Application's settings.

Building

To create a static package you can use anywhere (e.g. Github pages):

npm run build

The static site is located in build/dist/wpcom-console/public along with a tarball.

License

All source code licensed under the MIT open source license.