README.md

Offline-First App with Web Components

A concept of an app built with Web Components, with possibilities to query and manipulate data, and works totally offline.

You can try the online demo, and you can also reset the local modifications at anytime.

Step by step, building similar app

Here is a guide showing git diffs on how this app was built, highlighting:

• Using WebComponents and Polymer.
• Using PouchDB and its add-ons.
• Storing data locally.
• Modifying local storage.
• Replicating local storage to the remote server.
• Querying local storage.

Those steps are only the base for creating a similar app, always check the master branch for latest updates added on top of those steps.

Step 0 | Init empty Polymer app

Step 1 | Add a lazily loaded vaadin-grid

Step 2 | Get data from CouchDB using PouchDB

Step 3 | Load data from local storage

Step 4 | Add editor for selected item

Step 5 | Persist modifications in local storage

Step 6 | Sync local storage with remote DB

Step 7 | Add search box

Step 8 | Index local storage by firstName

Step 9 | Query local storage

Try out this application

Make sure you have Bower and Polymer CLI installed. Clone this project locally then:

Installing Dependencies

Install Bower dependencies

$ polymer install

Running Your Application

Start the application on port 8080

$ polymer serve --port 8080

Running Demo Mode

The app comes with a simple demo mode to run right away without a remote database. Usually you will be prompt to run the demo mode if no databases were found. You can also use the following arguments to explicitly request a demo mode:

• ?demo Run demo mode: http://localhost:8080/?demo
• ?resetdemo Reset demo mode: http://localhost:8080/?resetdemo

Configuring Database

You can run this app with a remote database as well, make sure you have a local CouchDB running, then create a database persondb inside CouchDB and fill it with dummy data or reset the existing one. Alternatively, you can create the database and fill it with dummy data by visiting the local setup page http://localhost:8080/setup.html.

Viewing Your Application

The application will be available on this address by default: http://localhost:8080.

Running Tests

Tests can be run locally by visiting this URL: http://localhost:8080/components/offline-first-app/test/.

You can also run tests using command line

$ polymer test