Modern Web Deployment Workflow
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
build
deploy
.gitignore
AUTHORS
Gruntfile.js
LICENSE-MIT
README.md
Vagrantfile
package.json

README.md

Modern Web Deployment Workflow

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.

Developing the project homepage

There are 2 ways to develop the example project.

Without vagrant, which is easier and faster:

  1. Ensure node.js and npm are installed.
  2. npm install
  3. npm run dev
  4. Check the main page: open public/index.html
  5. Check the 404 page: open public/404.html
  6. Edit build/* and deploy/README.md files locally, pages should auto-reload
  7. Repeat steps 4-6

With vagrant, which more accurately reflects site behavior once deployed:

  1. Ensure the deployment workflow dependencies as well as node.js and npm are installed.
  2. vagrant up
  3. npm install
  4. npm run dev
  5. Check the main page: http://deployment-workflow.loc/
  6. Check the 404 page: http://deployment-workflow.loc/whoops
  7. Edit build/* and deploy/README.md files locally, pages should auto-reload
  8. Repeat steps 5-7

When done, file a PR!