Refactored Faust Scaffold TS

.github/workflows/blueprint-export-diff.yml

@@ -9,7 +9,7 @@ jobs:
           fetch-depth: 0
       - uses: actions/setup-node@v2
         with:
-          node-version: '18'
+          node-version: "18"
       - name: Check for changes
         id: check-for-export-changes
         run: echo ::set-output name=check::$(git diff --name-only origin/main --exit-code -- acm-blueprint.zip)

.github/workflows/build.yml

@@ -5,7 +5,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: ['18', '20' ]
+        node: ["18", "20"]
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2

.gitignore

@@ -4,6 +4,7 @@
 /node_modules
 /.pnp
 .pnp.js
+package-lock.json
 
 # testing
 /coverage

.nvmrc

@@ -0,0 +1 @@
+lts/jod

DEVELOPMENT.md

@@ -14,4 +14,4 @@ This will import the ACM Blueprint export into your WordPress database. Make any
 
 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.
+3. Replace the existing `acm-blueprint.zip` in the repo with the newly exported `acm-blueprint.zip` and make a PR with the changes.

README.md

@@ -1,27 +1,91 @@
-# Faust Scaffold
+# ![Faust.js Logo](./.github/assets/faustjs-logo.svg) Faust.js Starter Kit
 
-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 a starter kit to get you up and running quickly on [WP Engine's Headless Platform](https://wpengine.com/headless-wordpress/) with a WordPress site skeleton for more advanced developers.
 
-# Installation
+## For more information
 
-Run `npm i`
-Change the `.env.local.sample` file's name to `.env.local.`
-Run `npm run build`
-Run `npm run generate`
-Run `npm run start`
+To get started on WP Engine's Platform please follow the docs here [https://developers.wpengine.com/docs/atlas/getting-started/create-app/](https://developers.wpengine.com/docs/atlas/getting-started/create-app/)
 
-While making changes to the scaffold, run `npm run dev` in another terminal window.
+## Project Structure
 
-## For more information
+```
+├── src/
+│   ├── __generated__/
+│   ├── components/
+│   ├── fragments/
+│   ├── pages/
+│   ├── queries/
+│   ├── styles/
+│   └── wp-templates/
+├── DEVELOPMENT.md
+├── faust.config.js
+├── next.config.js
+├── package.json
+├── possibleTypes.json
+└── README.md
+└── screenshots
+```
+
+## Available Commands
+
+| Command         | Script                                                                 | Description                        |
+| --------------- | ---------------------------------------------------------------------- | ---------------------------------- |
+| `dev`           | `npm run generate && concurrently "faust dev" "npm run watch-codegen"` | Start dev server and watch codegen |
+| `build`         | `faust build`                                                          | Build the project for production   |
+| `generate`      | `faust generatePossibleTypes`                                          | Generate GraphQL possible types    |
+| `start`         | `faust start`                                                          | Start the production server        |
+| `codegen`       | `graphql-codegen`                                                      | Run GraphQL code generation        |
+| `watch-codegen` | `graphql-codegen -w`                                                   | Watch and auto-run GraphQL codegen |
+| `format`        | `prettier . --write`                                                   | Format code with Prettier          |
+| `test:format`   | `prettier . --check`                                                   | Check code formatting              |
+
+## Screenshots
+
+<details>
+    <summary>View Screenshots</summary>
+
+![Front Page](screenshots/front-page.png)
+
+![Category Page](screenshots/category-page.png)
+
+![Single Page](screenshots/single-page.png)
 
-For more information on this Blueprint please check out the following sources:
+![Single Post](screenshots/single-post.png)
+
+</details>
+
+## Our Community 🩵
+
+At WP Engine, we have a strong community built around headless WordPress to support you with your journey.
+
+- [Discord Headless Community Channel](https://faustjs.org/discord)
+- [Fortnightly Headless Community Call](https://discord.gg/headless-wordpress-836253505944813629?event=1371472220592930857)
+- [WP Engine's Headless Platform developer community](https://wpengine.com/builders/headless)
+- [WP Engine`s Builders YouTube Channel](https://www.youtube.com/@WPEngineBuilders)
+- [WP Engine's Headless Platform](https://wpengine.com/headless-wordpress/)
+- [WP Engines Headless Platform Docs](https://developers.wpengine.com/docs/atlas/overview/)
+
+## Plugin Ecosystem 🪄
 
-- [WP Engine's Atlas Platform](https://wpengine.com/atlas/)
 - [Faust.js](https://faustjs.org)
+- [HWP Toolkit](https://github.com/wpengine/hwptoolkit)
 - [WPGraphQL](https://www.wpgraphql.com)
-- [WP Engine's Atlas developer community](https://developers.wpengine.com)
+- [WPGraphQL Content Blocks](https://github.com/wpengine/wp-graphql-content-blocks)
+- [WPGraphQL IDE](https://github.com/wp-graphql/wpgraphql-ide)
+- [WP GraphQL ACF](https://github.com/wp-graphql/wp-graphql-acf)
+
+## Documentation 🔎
+
+> [!NOTE]
+> We are continuously adding new docs for [Faustjs.org](https://faustjs.org/docs)
+
+- [Faust.js Documentation](https://faustjs.org/docs/)
+- [Headless Platform Documentation](https://wpengine.com/headless-wordpress/)
+- [WPGraphQL Documentation](https://developers.wpengine.com/docs/atlas/overview/)
+
+## Contributions
 
-### Contributor License Agreement
+## Contributor License Agreement
 
 All external contributors to WP Engine products must have a signed Contributor License Agreement (CLA) in place before the contribution may be accepted into any WP Engine codebase.
 

next.config.js

@@ -1,6 +1,11 @@
-const { withFaust, getWpHostname } = require('@faustwp/core');
+const { withFaust, getWpHostname } = require("@faustwp/core");
 
 /**
  * @type {import('next').NextConfig}
  **/
-module.exports = withFaust({});
+module.exports = withFaust({
+  images: {
+    domains: ["faustexample.wpengine.com"],
+  },
+  trailingSlash: true,
+});