zmgc.net – Our 100% serverless website built with React & Phenomic, Serverless Framework, and AWS Lambda!
JavaScript CSS HTML
Pull request Compare This branch is 20 commits ahead, 11 commits behind serverless:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
content
scripts
src
.eslintrc
.gitignore
.nvmrc
README.md
package.json
postcss.config.js
webpack.DLL.babel.js
webpack.config.js

README.md

ZMGC Site

This site is 100% serverless! 🎉

Built using react, redux and phenomic this site is statically built and hosted on the netlify CDN for 🔥blazingly fast performance and scale.

The site content, docs, and blog are hosted on github, so if you see a typo or error feel free to contribute back!

API calls are made with the serverless framework pinging AWS lambda functions. User Authentication is handled via Auth0. Site search handled by Algolia.

Quick Start

1. Clone down the site

git clone git@github.com:TZM/site.git

2. Install site dependencies

npm install

3. Run site on your local computer

npm start

Open your browser to http://localhost:3333

Run npm run syncProd or npm run syncLocal to pull in the blog and docs repos (if the postinstall command doesn't run for you). These 2 commands pull in the external content sources the site uses.

Editing Site Content

When you start the site with npm start it will start watching for file changes and they will be automatically refreshed in the site on http://localhost:3333

Blog edits:

To make edits to blog posts, edit the files in ./blog/posts (this directory is added on npm i)

Doc edits:

To make edits to framework docs, edit the files in ./serverless/docs (this directory is added on npm i)

Editing other pages

To make edits to other pages, edit the markdown in ./content

Some pages have custom designs/layouts and the html might need to be altered. That content can be found in ./src/layouts or ./src/pages

Publishing Site Updates

1. Test the build command locally

npm run build

2. If build command succeeds, push up your changes to a new branch

We are using netlify to distribute the site.

When pushing up to a new branch, netlify will automatically publish that change to a unique subdomain, like: https://[lowercase-branch-name]--serverless.netlify.com

For example the branch updateDocsSetup published to https://updatedocssetup--serverless.netlify.com

Successful deploys are published to the notifications slack channel

Note: The master branch is the live site. Never push directly to the master branch!

3. Review your live site changes

If everything looks good on your unique netlify subdomain, you can go ahead and merge your branch to master on github.

Merging branches into master will trigger a site rebuild and zmgc.net will be updated.

Making Phenomic changes while working on the site

If you want to work on phenomic src code while working on the site, change the transpile path in phenomic's package.json to point to the the sites node_module path. ../site/node_modules/phenomic/lib

Then inside of the phenomic src directory you can run npm run transpile -- --watch to work on phenomic src code and see the live changes effect the serverless site.