An opinionated progressive web app boilerplate
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
client add ssr and client render support for async components using react-lo… Dec 13, 2017
config remove analytics May 27, 2017
server
.babelrc revert to previously used folder structure and relative paths Nov 9, 2017
.editorconfig make .editorconfig the root Jan 28, 2017
.eslintignore
.eslintrc lint only staged files on precommit Dec 13, 2017
.gitignore lint only staged files on precommit Dec 13, 2017
.stylelintignore lint only staged files on precommit Dec 13, 2017
.stylelintrc initial commit Jan 21, 2017
LICENSE add MIT license Feb 28, 2017
README.md
package.json readme and description cleanup Dec 13, 2017
pm2.json initial commit Jan 21, 2017
postcss.config.js use simpler postcss config syntax Jul 27, 2017
webpack.client.js restructure vendor Dec 13, 2017
webpack.server.js revert to previously used folder structure and relative paths Nov 9, 2017

README.md

Progressive Web App

A production grade progressive web app, to hit the ground running.

Setup

$ npm install

ENV Variables

  • NODE_ENV (build-dependent)

    • development: modules are bundled as is
    • production: modules are minified and uglified
  • PWA_ENV (build-dependent)

    • development: configs are obtained from /config/development.js
    • production: configs are obtained from /config/production.js
    • customPwaEnv: configs are obtained from /config/customPwaEnv.js
  • PWA_PUBLIC_PATH (build-dependent)

    • /build/client/: assets are fetched from the local filesystem
    • /production.cdn.com/build/client/: assets are fetched from this cdn path
    • /custom/path/: assets are fetched from /custom/path/
  • PWA_SSR (build-independent)

    • true: enable server side data fetching and rendering
    • false: disable server side data fetching and rendering
  • PORT (build-independent)

    • 8000: serve the app at port 8000
    • 1337: serve the app at port 1337

build-dependent: if any of these variables values have to be changed, assuming you change PWA_PUBLIC_PATH=//other.cdn.com in the staging:build script, then it requires a rebuild and a restart, npm run staging

build-independent: if any of these variable values have to be changed, assuming you change PWA_SSR=false in the staging:start script, then it only requires a restart, npm run staging:start

Usage

There are some useful npm scripts setup for you to start using these ENV variables effectively, please look at package.json to better understand how they're setup for each script.

Remember to run npm stop to stop all the pwa pm2 instances before using a different script from below.

Start as local development server with file watching:

$ npm start
# runs at http://localhost:8000
# npm run stop is automatically called for you after
# hitting ctrl+c to quit the webpack-dev-server

Start as local production server:

$ npm run development
# runs at http://localhost:1337

Start as staging server:

$ npm run staging
# runs at http://localhost:1337

Start as production server:

$ npm run production
# runs at http://localhost:1337

Using pm2:

$ npm run pm2 -- logs # follow all server logs
$ npm run pm2 -- list # list all processes
$ npm run pm2 -- kill # kill pm2 parent process
$ npm run pm2 -- help # show other available commands

License

MIT