Skip to content

Latest commit

 

History

History
95 lines (60 loc) · 3.65 KB

README.md

File metadata and controls

95 lines (60 loc) · 3.65 KB
Raw

NH Proposal Generator

Deploy to Netlify

Netlify Status

This repo contains an example proposal website that is built with Gatsby, and Netlify CMS: Demo Link.

It follows the JAMstack architecture by using Git as a single source of truth, and Netlify for continuous deployment, and CDN distribution.

To Do

  • mobile view fixes if needed

Features

  • A simple landing page built with Netlify CMS
  • Editabe Pages
  • Basic directory organization
  • Blazing fast loading times thanks to pre-rendered HTML and automatic chunk loading of JS files
  • Uses gatsby-image with Netlify-CMS preview support
  • Separate components for everything
  • Netlify deploy configuration
  • Netlify function support, see lambda folder
  • Perfect score on Lighthouse for SEO, Accessibility and Performance (wip:PWA)
  • ..and more

Prerequisites

Getting Started (Recommended) ✅

Netlify CMS can run in any frontend web environment, but the quickest way to try it out is by running it on a pre-configured starter site with Netlify. Use the deploy button above to build and deploy your own copy of this repository.

After clicking that button, you’ll authenticate with GitHub and choose a repository name. Netlify will then automatically create a repository in your GitHub account with a copy of the files from the template.

Next, it will build and deploy the new site on Netlify, bringing you to the site dashboard when the build is complete.

Next, you’ll need to set up Netlify’s Identity service to authorize users to log in to the CMS. In Netlify go to Settings > Identity > External Providers > Add Provider and choose GitHub.

Now when you go to your new site's address /admin you should be able to choose "Continue with GitHub" and log in.

Access and Run Locally

Pulldown a local copy of this repo

yarn
netlify dev # or ntl dev

This uses the new Netlify Dev CLI feature to serve any functions you have in the lambda folder.

To test the CMS locally, you'll need to run a production build of the site:

npm run build
netlify dev # or ntl dev

Getting Started (Without Netlify)

yarn
yarn develop

Setting up the CMS

Follow the Netlify CMS Quick Start Guide to set up authentication, and hosting.

Netlify Commands

ntl init to run through setup

netlify open --admin opens netlify admin

netlify open --site opens site url

Debugging

Windows users might encounter node-gyp errors when trying to npm install. To resolve, make sure that you have both Python 2.7 and the Visual C++ build environment installed.

npm config set python python2.7
npm install --global --production windows-build-tools

Full details here

MacOS users might also encounter some errors, for more info check node-gyp. We recommend using the latest stable node version.