Bring App

Monorepo containing the Bring App project template and its supporting packages.

Setup

• Install all dependencies in all workspaces with yarn
• Create the necessary .env files in the bring-app, /next-app and /plugins/bring-app folders
• Start the backend services in docker with yarn services:up
• Build the plugin and start the development with yarn dev
• Activate the Bring App plugin
• Happy building!

Bring App Folders

• plugins/bring-app The Bring App plugin for WordPress containing the core functionality and project specific customizations
• themes/bring-app-theme Minimal theme for the headless WordPress Bring App architecture
• next-app/ For the frontend that mirrors the routing of WordPress
• wordpress/ The wordpress folder for local development

Publish new package versions

• yarn changeset: Bump package versions and commit changelog message

Important scripts

• yarn or yarn install : Install all dependencies in all workspaces
• composer install then composer dump-autoload: Install all php dependencies (automatically runs after yarn)
• yarn dev : Start development server
• yarn build : Create production build
• yarn storybook : Start storybook development server
• yarn checks : Lints and types all workspaces
• yarn format : Formats all files in all workspaces

Useful scripts

• yarn workspace <workspace-name> add <package-name> : Add new package to one workspace
• yarn workspace <workspace-name> remove <package-name> : Remove package from one workspace
• yarn workspace <workspace-name> run <script-name> : Run a script in a specific workspace
• yarn syncpack <syncpack-command> : Run syncpack command to sync package versions, type yarn syncpack --help for more info

Starting a new project

To initialize a new Bring App project, please refer to the app Readme.

Documentation

For API documentation of the Bring packages, visit our Docs page.

Philosophy

For a comprehensive overview and deeper insights into the project's purpose and structure, please refer to the Introduction docs.