This is a fully working example of ReactJS for working in offline mode. This repository is to get you started with the development of your application right away without worrying about the basic configurations. It provides you with the following packages out of the box.
Complete configuration of redux store for offline mode is also present, you need not to worry for that.
These instructions will get you a copy of the project up and running on your local machine for development.
What things you need to install the software and how to install them
Git & NPM or Yarn installed on your local machine
A step by step series of examples that tell you how to get a development env running
$ git clone https://github.com/mansern/offline-first-demo.git
$ npm install && npm start
.
├── public # Containing HTMl and Mainfest file
├── src # Source Root
│ ├── assets # Static Assets CSS & SCSS
│ └── containers # Containers where data fetching will be done
│ └── images # Images are placed here
| └── redux # Global Redux files
│ └── index.js # Applications Entry Point.
└── ... #etc
Package we are using requires global installation which every developer must do.
npm install -g documentation
# generate html docs for all files in src
Usage :: documentation build src/** -f html -o docs
# This command will create a docs folder and will generate the HTML docs of all components inside the "src" folder.
# Usage example is in containers/project/home
Available format options :: HTML, Markdown, JSON
Command line HTTP server is also installed if you want offline testing. It serves the build folder for actual
production testing. You simply have to do:
- npm run build
- npm run start-sw
- Muhammad Anser Naseer ([email protected])