@feathersjs-offline/example

An example client and server showcasing FeathersJS offline-first realtime support for own-data and own-net protocols as described in the docs here.

This example is a showcase of the algorithms and not your usual implementation (which is a lot simpler - just follow the descriptions here).

Installation

git clone https://github.com/feathersjs-offline/simple-example

Documentation

This collection of packages i interesting due to to mainly two things:

• it fully supports own-data and own-net as described in You can read the docs offline-first and the updated docs here.
• it can be used almost invisibly - you do not have to change your coding habits to utilize it, just set it up and forget all about it!

Running the Example

After cloning the repository execute

cd feathersjs-offline/simple-example
npm install

This will take a couple of minutes. When this has completed successfully you start the server by executing

node server

The server will start and write a message like:

Feathers application started on http://localhost:3031

after create data = {"text":"This is a message from The Creator Himself!","updatedAt":"2020-12-11T07:05:58.258Z","uuid":"7_lEahFZN","onServerAt":"2020-12-11T07:05:58.323Z"}
result: {"text":"This is a message from The Creator Himself!","updatedAt":"2020-12-11T07:05:58.258Z","uuid":"7_lEahFZN","onServerAt":"2020-12-11T07:05:58.323Z"}

Now you point your favourite browser to http://<WHATEVER-YOUR-PATH-WAS>/ and you should be running.

You can open several windows if you want to see what happens when multiple clients operate at the same time both online and offline.

If you want to explore using different storage backends (in the browser) you can do that by specifying the db parameter like:

http://<WHATEVER-YOUR-PATH-WAS>/?db=<DB-specification>

where <DB-specification> can be any of WebSQL, IndexedDB, or LocalStorage. You can supply a preferred sequence by separating the backend name with commas e.g.:

http://<WHATEVER-YOUR-PATH-WAS>/?db=WebDB,IndexedDB

will use WebDB if available. Next it will try IndexedDB. If this also fails we will automatically fall-back to LocalStorage.

We presuppose you have npm and node installed otherwise you will have to install them before running the example.

License

Copyright (c) 2020

Licensed under the MIT license.