The files and directory you care about are:
Everything else is used to generate the project home page, which is just a stylized version of the main project documentation (deploy/README.md). And yes, the deployment workflow homepage is deployed using the deployment workflow.
If this is your first time here, you should start by reading the documentation.
There are 2 ways to develop the example project.
Without vagrant, which is easier and faster:
- Ensure node.js and npm are installed.
npm install
npm run dev
- Check the main page:
open public/index.html
- Check the 404 page:
open public/404.html
- Edit
build/*
anddeploy/README.md
files locally, pages should auto-reload - Repeat steps 4-6
With vagrant, which more accurately reflects site behavior once deployed:
- Ensure the deployment workflow dependencies as well as node.js and npm are installed.
vagrant up
npm install
npm run dev
- Check the main page: http://deployment-workflow.loc/
- Check the 404 page: http://deployment-workflow.loc/whoops
- Edit
build/*
anddeploy/README.md
files locally, pages should auto-reload - Repeat steps 5-7
When done, file a PR!