{"id":15040515,"url":"https://github.com/automattic/wp-api-console","last_synced_at":"2025-10-19T19:30:23.483Z","repository":{"id":40535031,"uuid":"71791890","full_name":"Automattic/wp-api-console","owner":"Automattic","description":"WordPress (.com and .org) API Console written in React/Redux","archived":false,"fork":false,"pushed_at":"2024-01-04T21:14:10.000Z","size":771,"stargazers_count":71,"open_issues_count":27,"forks_count":20,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-01-30T01:12:38.367Z","etag":null,"topics":["api","react","wordpress"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Automattic.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2016-10-24T13:28:43.000Z","updated_at":"2024-12-18T12:04:06.000Z","dependencies_parsed_at":"2023-11-13T16:38:48.651Z","dependency_job_id":null,"html_url":"https://github.com/Automattic/wp-api-console","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Automattic%2Fwp-api-console","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Automattic%2Fwp-api-console/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Automattic%2Fwp-api-console/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Automattic%2Fwp-api-console/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Automattic","download_url":"https://codeload.github.com/Automattic/wp-api-console/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237200494,"owners_count":19271153,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","react","wordpress"],"created_at":"2024-09-24T20:44:41.669Z","updated_at":"2025-10-19T19:30:18.030Z","avatar_url":"https://github.com/Automattic.png","language":"JavaScript","readme":"# WordPress.com API Console v3\n\nThis is the current version of the WordPress.com API console, written in React. It is deployed at:\n\nhttps://developer.wordpress.com/docs/api/\n\nIt supercedes https://github.com/Automattic/rest-api-console2.\n\n## Getting Started Locally\n\nTo setup the environment on your local system with WordPress.com APIs:\n\n1. Clone the repository `git clone https://github.com/Automattic/wp-api-console.git`.\n\n2. 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.\n\n3. Open [WordPress.com Developer Resources](https://developer.wordpress.com/apps/)\n\n4. 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.\n\n5. Copy `src/config.sample.json` to `src/config.json` and fill \"client_id\" and \"redirect_uri\" with the values from the app created above.\n\n6. Run the dev server `npm start`. The app will start at [http://localhost:3000](http://localhost:3000).\n\n7. Click on the key to authenticate.\n\nFor more details, see below or check out the [technical documentation](./DOC.md).\n\n\n\n## Configuration\n\n### Using with WordPress.com APIs\n\nTo use with WordPress.com, visit [WordPress.com Developer Resources](https://developer.wordpress.com/apps/) and create an application.\n\nCopy `src/config.sample.json` to `src/config.json` and use your WordPress.com Client ID and Redirect URI for the values.\n\nMake sure you add your host to the Javascript Origins / CORS whitelist in the Application's settings.\n\n```json\n{\n  \"wordpress.com\": {\n    \"clientID\": \"33333\",\n    \"redirectUrl\": \"http://localhost:3000\"\n  }\n}\n```\n\n### Using with your self-hosted WordPress site\n\nYou can also use this console with your WordPress.org installation but make\nsure to install the\n[WP REST API - OAuth 1.0a Server](https://oauth1.wp-api.org/)\nfirst, create an app (in the Users → Applications screen), and then edit the\n`src/config.json` like this:\n\n```javascript\n{\n  \"wordpress.org\": [\n    {\n      \"name\": \"Dev\",                         // Name to display on the API selector\n      \"url\": \"http://wordpress.dev\",         // Base URL of your WordPress website\n      \"clientKey\": \"PwQXbJdBYrXq\",           // Client (public) key of your application\n      \"secretKey\": \"XB9oidFfxr3g...\",        // Secret key of your application\n      \"callbackUrl\": \"http://localhost:3000\" // Callback URL where you are running this console\n    }\n  ]\n}\n```\n\nNote that your `callbackUrl` must match the configured value for the application.\nIf you are having an error like \"Callback URL is invalid\", try putting a trailing\nslash at the end of your callback URL\n([details](https://github.com/WP-API/example-client/issues/5)).\n\nYou can also install the\n[Application Passwords plugin](https://github.com/georgestephanis/application-passwords/)\nand use basic authentication to communicate with your site.  Make sure that\nyour site is running over HTTPS, otherwise this is insecure.  Here are the\nconfig settings for basic auth:\n\n```javascript\n{\n  \"wordpress.org\": [\n    {\n      \"name\": \"Dev (basic)\",                 // Name to display on the API selector\n      \"url\": \"https://wordpress.dev\",        // Base URL of your WordPress website\n      \"authType\": \"basic\",\n      \"authHeader\": \"Basic bWU6bXlwYSBzc3dvIHJk\"\n    }\n  ]\n}\n```\n\nYou 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):\n\n```sh\n$ echo -n 'mywpusername:mypa sswo rd' | base64\nbWU6bXlwYSBzc3dvIHJk\n```\n\n\n## Building a Static Package\n\nTo create a static package you can use anywhere (e.g. Github pages): `npm run build`\n\nThe static site is located in `build`\n\n\n## Deploying\n\nIf you want to quickly deploy the console to [Surge](https://surge.sh), just run `npm run deploy`.\n\n\n## Deploying to WordPress.com\n\n- Run the `./bin/build-for-wpcom.sh` script. This should generate a\n  `build-theme` directory.\n- See PCYsg-baa-p2 for further instructions.\n\n\n## License\n\nAll source code is licensed under [GNU General Public License v2 (or later)](./LICENSE).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fautomattic%2Fwp-api-console","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fautomattic%2Fwp-api-console","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fautomattic%2Fwp-api-console/lists"}