Skip to content

A scaffolding for Express, Google Workbox, Webpack, and Babel for creating modern Progressive Web Apps. Also integrated Ngrok, Materialize and Iconify.

License

Notifications You must be signed in to change notification settings

MelodicCrypter/Express-Workbox-Webpack-Babel-Scaffold

Repository files navigation

Build Status

Express, Workbox, Webpack, and Babel Scaffolding

Let's you create a modern PWA (Progressive Web App) on the fly. You can setup a PWA app from scratch, but using well-tested and well-maintained technology like Workbox will make your life a lot easier and faster.


Usage

  1. yarn install
  2. Since this scaffold uses Ngrok for tunnelling, so that you can test your app on devices while on development stage, you need to get your token at Ngrok. After that, put your token inside webpack.config.js (line 99) file.
  3. yarn prep ( run this once only )

If already ran -yarn prep- before, you can directly use these

👨‍💻 yarn start:dev-ar (with auto-reload) or start:dev (no auto-reload)


Screen Shot 2019-08-22 at 4 56 43 PM


Ports

You can change the port for Express inside public/server.js. You can change your port for Ngrok inside .ngrok.js. You can change Light-Server's port inside .lightrc.

NOTE: For Ngrok to work, ports for Express and Ngrok must match.


Workbox (PWA)

You can modify all your Service Worker stuffs inside public/src-sw.js file. You can put all your routes, caches, etc. Don't edit public/sw.js directly. Webpack will automatically generate that file for you. You can modify or rename /public/views/fallback.html file but please don't delete it. If you rename it, please also update the public/src-sw.js file, in the number 9 section saying 'Provided offline or fallback support'. Don't forget to update the manifest file inside public/ to match the name of your app, icons, settings, etc. Also, you can turn on Debug if you are still in development phase, still inside src-sw.js file.


Just Ignore These Files:

These files are used if you are going to deploy to Elastic Beanstalk. You can delete these if you want.

  1. .ebextensions
  2. .ebignore

About

A scaffolding for Express, Google Workbox, Webpack, and Babel for creating modern Progressive Web Apps. Also integrated Ngrok, Materialize and Iconify.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published