Git Product home page Git Product logo

offline-first-demo's Introduction

React-Offline-First

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.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development.

Prerequisites

What things you need to install the software and how to install them

Git & NPM or Yarn installed on your local machine

Installation

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

Folder Structure

.
├── 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

Documentation

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

HTTP Server

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

Built With

Authors

offline-first-demo's People

Contributors

mansern avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.