diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md deleted file mode 100644 index 1d7cdcc..0000000 --- a/DEVELOPMENT.md +++ /dev/null @@ -1,17 +0,0 @@ -# Development - -## Updating the ACM Blueprint Export - -### Importing - -1. Create a fresh site in Local or use the FakerPress plugin to wipe your current WordPress database to a fresh install. -2. Install and activate Atlas Content Modeler. -3. From the WP CLI, run `wp acm blueprint import `. You can use the GitHub RAW URL from the repo: https://github.com/wpengine/faust-scaffold/raw/main/acm-blueprint.zip - -This will import the ACM Blueprint export into your WordPress database. Make any modifications as necessary. - -### Exporting - -1. Before exporting, make sure you have deleted any of the initial content that gets created upon a WordPress install (e.g. "Sample Page", "Hello World", any comments, etc.) -2. From the WP CLI, run `wp acm blueprint export --open --wp-options=category_base,permalink_structure,nav_menu_options,theme_mods_twentytwentytwo --post-types=nav_menu_item,post,page,testimonial,project`. This will export the site into the appropriate ACM Blueprint .zip, and also open the location where the .zip was saved. It will also export the Navigational Menus and the CPTs from the ACM models. -3. Replace the existing `acm-blueprint.zip` in the repo with the newly exported `acm-blueprint.zip` and make a PR with the changes. \ No newline at end of file diff --git a/README.md b/README.md index 0060ad9..ca99d29 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,34 @@ -# Faust Scaffold +# acf.wpgraphql.com -This repository contains a starter scaffolding to get you up and running quickly on [WP Engine's Atlas platform](https://wpengine.com/atlas/) with a WordPress site skeleton for more advanced developers. +This repository contains the Next.js application intended for acf.wpgraphql.com. -## For more information +## 🧰 Built With -For more information on this Blueprint please check out the following sources: +- [wpengine/faust-scaffold](https://github.com/wpengine/faust-scaffold) +- [wpengine/wp-graphql-content-blocks](https://github.com/wpengine/wp-graphql-content-blocks) +- [wp-graphql/wp-graphql](https://github.com/wp-graphql/wp-graphql) +- [wp-graphql/wpgraphql-acf](https://github.com/wp-graphql/wpgraphql-acf) +- [ACF](https://www.advancedcustomfields.com/) +- [shadcn/ui](https://ui.shadcn.com/) -- [WP Engine's Atlas Platform](https://wpengine.com/atlas/) -- [Faust.js](https://faustjs.org) -- [WPGraphQL](https://www.wpgraphql.com) -- [Atlas Content Modeler](https://wordpress.org/plugins/atlas-content-modeler/) -- [WP Engine's Atlas developer community](https://developers.wpengine.com) +## ⌨️ Development + +Install dependencies + +```sh +npm install +``` + +Create the `.env.local` + +```sh +cp .env.local.sample .env.local +``` + +_Add the appropriate FAUST_SECRET_KEY from the connected WordPress site._ + +Run the development server + +```sh +npm run dev +```