Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/automattic/wp-api-console
WordPress (.com and .org) API Console written in React/Redux
https://github.com/automattic/wp-api-console
api react wordpress
Last synced: 3 months ago
JSON representation
WordPress (.com and .org) API Console written in React/Redux
- Host: GitHub
- URL: https://github.com/automattic/wp-api-console
- Owner: Automattic
- License: gpl-2.0
- Created: 2016-10-24T13:28:43.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-01-04T21:14:10.000Z (12 months ago)
- Last Synced: 2024-10-07T11:19:20.247Z (3 months ago)
- Topics: api, react, wordpress
- Language: JavaScript
- Homepage:
- Size: 753 KB
- Stars: 70
- Watchers: 7
- Forks: 20
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WordPress.com API Console v3
This is the current version of the WordPress.com API console, written in React. It is deployed at:
https://developer.wordpress.com/docs/api/
It supercedes https://github.com/Automattic/rest-api-console2.
## Getting Started Locally
To setup the environment on your local system with WordPress.com APIs:
1. Clone the repository `git clone https://github.com/Automattic/wp-api-console.git`.
2. Install dependencies `npm ci --legacy-peer-deps`. Switch to Node v16 - If you use `nvm`, add a `.nvmrc` file with the version `16.20.2` on it as this project can't run on higher node version.
3. Open [WordPress.com Developer Resources](https://developer.wordpress.com/apps/)
4. Create New Application: fill the form. Under "Redirect URI" and "Javascript Origins" specify `http://localhost:3000` (or where your local app will run). After creation keep the OAuth Information details at hand.
5. Copy `src/config.sample.json` to `src/config.json` and fill "client_id" and "redirect_uri" with the values from the app created above.
6. Run the dev server `npm start`. The app will start at [http://localhost:3000](http://localhost:3000).
7. Click on the key to authenticate.
For more details, see below or check out the [technical documentation](./DOC.md).
## Configuration
### Using with WordPress.com APIs
To use with WordPress.com, visit [WordPress.com Developer Resources](https://developer.wordpress.com/apps/) and create an application.
Copy `src/config.sample.json` to `src/config.json` and use your WordPress.com Client ID and Redirect URI for the values.
Make sure you add your host to the Javascript Origins / CORS whitelist in the Application's settings.
```json
{
"wordpress.com": {
"clientID": "33333",
"redirectUrl": "http://localhost:3000"
}
}
```
### Using with your self-hosted WordPress site
You can also use this console with your WordPress.org installation but make
sure to install the
[WP REST API - OAuth 1.0a Server](https://oauth1.wp-api.org/)
first, create an app (in the Users → Applications screen), and then edit the
`src/config.json` like this:
```javascript
{
"wordpress.org": [
{
"name": "Dev", // Name to display on the API selector
"url": "http://wordpress.dev", // Base URL of your WordPress website
"clientKey": "PwQXbJdBYrXq", // Client (public) key of your application
"secretKey": "XB9oidFfxr3g...", // Secret key of your application
"callbackUrl": "http://localhost:3000" // Callback URL where you are running this console
}
]
}
```
Note that your `callbackUrl` must match the configured value for the application.
If you are having an error like "Callback URL is invalid", try putting a trailing
slash at the end of your callback URL
([details](https://github.com/WP-API/example-client/issues/5)).
You can also install the
[Application Passwords plugin](https://github.com/georgestephanis/application-passwords/)
and use basic authentication to communicate with your site. Make sure that
your site is running over HTTPS, otherwise this is insecure. Here are the
config settings for basic auth:
```javascript
{
"wordpress.org": [
{
"name": "Dev (basic)", // Name to display on the API selector
"url": "https://wordpress.dev", // Base URL of your WordPress website
"authType": "basic",
"authHeader": "Basic bWU6bXlwYSBzc3dvIHJk"
}
]
}
```
You can generate the base64-encoded portion of the `authHeader` as follows, using your WP username and your application password (this is the password generated by the plugin, NOT your WP password for your site):
```sh
$ echo -n 'mywpusername:mypa sswo rd' | base64
bWU6bXlwYSBzc3dvIHJk
```
## Building a Static Package
To create a static package you can use anywhere (e.g. Github pages): `npm run build`
The static site is located in `build`
## Deploying
If you want to quickly deploy the console to [Surge](https://surge.sh), just run `npm run deploy`.
## Deploying to WordPress.com
- Run the `./bin/build-for-wpcom.sh` script. This should generate a
`build-theme` directory.
- See PCYsg-baa-p2 for further instructions.
## License
All source code is licensed under [GNU General Public License v2 (or later)](./LICENSE).