https://github.com/wpengine/faust-scaffold-ts

Faust Scaffold Blueprint in TypeScript
https://github.com/wpengine/faust-scaffold-ts

Last synced: about 2 months ago
JSON representation

Faust Scaffold Blueprint in TypeScript

• Host: GitHub
• URL: https://github.com/wpengine/faust-scaffold-ts
• Owner: wpengine
• Created: 2023-03-28T17:26:19.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-12T12:03:59.000Z (4 months ago)
• Last Synced: 2024-09-12T23:18:43.556Z (4 months ago)
• Language: TypeScript
• Homepage:
• Size: 467 KB
• Stars: 11
• Watchers: 36
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# Faust Scaffold

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.

# Installation

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`

While making changes to the scaffold, run `npm run dev` in another terminal window.

## For more information

For more information on this Blueprint please check out the following sources:

- [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)

### 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.

1. [Submit your name and email](https://wpeng.in/cla/)

2. 📝 Sign the CLA emailed to you

3. 📥 Receive copy of signed CLA

❤️ Thank you for helping us fulfill our legal obligations in order to continue empowering builders through headless WordPress.