manifest / performance / verso

Verso Headless API

a WordPress plugin that turns any install into a hidden, headless REST API for your React app. It handles front-end blocking, CORS, custom endpoints, caching and API lockdown.

by erme2 · github.com/erme2/verso

★ 0stars

Install

Download source zip No release zip yet

This is the repository archive. It installs, but the folder name will carry the branch suffix and updates will not flow.

Install straight from GitHub with WP-CLI:

wp plugin install https://github.com/erme2/verso/archive/refs/heads/main.zip

No built-in updater. New versions won't appear under Dashboard → Updates. Install new releases yourself, or let Git Updater track the repository.

Readme github.com/erme2/verso ↗

Verso is planned as a headless WordPress content API for a React application. WordPress will provide the editor experience and a custom plugin will shape and secure the REST API; the public site will be served by the React application.

Project status

The WordPress plugin skeleton is in place. ADR-0001 records the proposed architecture and its open questions. The decision is still marked Proposed; the API, settings, CORS, and front-end behavior have not been implemented.

Engineering workflow

Yaup is the project's source of truth for work tracking and the primary engineering guardrail. All planned and active work must have a Yaup ticket. Follow the ticket's acceptance criteria, status, and review lifecycle; keep implementation scope and progress aligned with the ticket. Do not treat this README or an untracked request as a replacement for Yaup.

Repository-specific agent guidance is in AGENTS.md. Record durable architecture decisions in ADRs and update them when decisions change.

Planned architecture

WordPress is used for content management and REST API responses, not public theme rendering.
A versioned custom WordPress plugin owns headless configuration, CORS, front-end blocking, custom endpoints, permissions, caching, and API surface restrictions.
A React application consumes the API from the public site.

See ADR-0001 for the proposed v1 scope, trade-offs, risks, and unresolved questions.

Development

From the repository root, run npx @wordpress/env start to start the local WordPress environment. The Verso plugin is mounted from this repository and is available at http://localhost:8888. Stop the environment with npx @wordpress/env stop.

The environment uses wp-env, configured in .wp-env.json.

The plugin entry point is verso.php. Do not infer deployment settings or credentials from the architecture proposal.

License

See LICENSE.