Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial docs #14

Merged
merged 2 commits into from
Oct 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 0 additions & 17 deletions DEVELOPMENT.md

This file was deleted.

39 changes: 30 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
```
Loading