search

10up / headstartwp

Build a headless website fast with WordPress, the world’s most popular CMS, and Next.js, the most popular React framework. A free and open source solution by the experts at 10up.
https://headstartwp.10up.com
166 stars 17 forks source link

readme

HeadstartWP

A modern headless WordPress solution.

Support Level eslint PHPCS check unit tests Core Package MIT License Hooks Package MIT License Next Package MIT License wp-multisite-i18n-nextjs Project GPLv2 License wp-multisite-nextjs Project GPLv2 License wp-nextjs Project GPLv2 License HeadstartWP Plugin GPLv2 License

Documentation

See our Getting Started guide.

Visit headstartwp.10up.com/docs for the full documentation.

Running docs site locally

The docs site lives in the docs directory. It is currently not part of the monorepo/workspace setup so npm install must be executed in the docs dir. To run the docs site locally run the following commands:

cd docs
npm install
npm run start

Support Level

Active: 10up is actively working on this, and we expect to continue work for the foreseeable future including keeping tested up to the most recent version of WordPress. Bug reports, feature requests, questions, and pull requests are welcome.

Changelog

A complete listing of all notable changes to 10up's Headless Framework are documented in CHANGELOG.md files within the core, hooks, and next packages.

Repository Structure and Engineering Guidelines

Visit the CONTRIBUTING page for initial contribution and engineering guidance.

This repository is a monorepo, under the packages there are all the tools that are published to npm. The projects directory is a collection of test projects linked to the tools in packages and is used for testing purposes.

Like what you see?

10up