Skip to content

Latest commit

 

History

History
37 lines (23 loc) · 1.82 KB

README.md

File metadata and controls

37 lines (23 loc) · 1.82 KB
Raw

Next.js PWA Boilerplate

Next.js PWA Boilerplate starts your progressive web app off with a perfect Google Lighthouse score. To see this in action, open the website with Chrome, go to the “Audits” tab in dev tools, and click “Run audit”.

Technologies Used

  • React.js - A JavaScript library for building user interfaces
  • Styled Components - Use the best bits of ES6 and CSS to style your apps without stress
  • Next.js - A minimalistic framework for server-rendered React applications
  • ZEIT Now 2 for hosting the app on the web with auto-scaling, auto-renewing of SSL certs, and the ability to add any lambda functions in any other language

Run locally

One-Time Setup

Must have Git and Node.js installed:

  1. git clone https://github.com/pingboard/next-pwa-boilerplate
  2. npm i
  3. Replace all images in ./static/graphics/ with your desired app icons, splash screens, and thumbnail for social sharing. If you have Sketch, you can use the artboards included in ./graphics.sketch. Ensure that all replacement graphics include the same filenames, file type, and dimensions.

Run

npm run dev and go to http://localhost:3000

Deploying

One-Time Setup

  1. Make an account on ZEIT.
  2. Install Zeit’s Now CLI: npm install -g now
  3. Change the name and alias on now.json to your unique string. If you don’t have a full domain with ZEIT, yourUniqueString.now.sh will the domain.
  4. Replace the next-pwa-boilerplate inside https://next-pwa-boilerplate.now.sh in ./pages/_document.js with the same string as the previous step.

Deploy

npm run deploy