Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/feathersjs-offline/owndata-ownnet
This repository holds the necessary tools to bring own-data/own-net offline-first to FeathersJS applications.
https://github.com/feathersjs-offline/owndata-ownnet
feathers mobile mutations offline-first realtime
Last synced: 3 months ago
JSON representation
This repository holds the necessary tools to bring own-data/own-net offline-first to FeathersJS applications.
- Host: GitHub
- URL: https://github.com/feathersjs-offline/owndata-ownnet
- Owner: feathersjs-offline
- License: mit
- Created: 2020-12-03T09:14:54.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-03-24T12:05:40.000Z (over 1 year ago)
- Last Synced: 2024-07-17T15:29:00.025Z (4 months ago)
- Topics: feathers, mobile, mutations, offline-first, realtime
- Language: JavaScript
- Homepage: https://feathersjs-offline.github.io/docs/
- Size: 1.01 MB
- Stars: 17
- Watchers: 4
- Forks: 4
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/contributing.md
- License: LICENSE
Awesome Lists containing this project
- awesome-feathersjs - @feathersjs-offline/owndata-ownnet - FeatherJS Offline-first realtime database wrapper implements the offline-first `own-data` / `own-net` replication principles on CRUD methods on any Feathers database adapter. (Frontend frameworks / Framework Agnostic)
README
Server [](https://www.npmjs.com/package/@feathersjs-offline/server)
[](https://github.com/feathersjs-offline/owndata-ownnet/actions)
[](https://david-dm.org/@feathersjs-offline/server)
[](https://snyk.io/test/github/feathersjs-offline/owndata-ownnet)
[](https://codeclimate.com/github/feathersjs-offline/owndata-ownnet/maintainability)
[](https://codeclimate.com/github/feathersjs-offline/owndata-ownnet/test_coverage)
[](https://www.npmjs.com/package/@feathersjs-offline/server)
[](https://lerna.js.org/)
Client [](https://www.npmjs.com/package/@feathersjs-offline/client)
[](https://github.com/feathersjs-offline/owndata-ownnet/actions)
[](https://david-dm.org/@feathersjs-offline/client)
[](https://snyk.io/test/github/feathersjs-offline/owndata-ownnet)
[](https://codeclimate.com/github/feathersjs-offline/owndata-ownnet/maintainability)
[](https://codeclimate.com/github/feathersjs-offline/owndata-ownnet/test_coverage)
[](https://www.npmjs.com/package/@feathersjs-offline/client)
[](https://lerna.js.org/)
# Feathers offline-first own-data / own-net
These packages implements the offline-first `own-data` / `own-net` principles on CRUD methods on any Feathers database adapter. It consist of two parts; one for the server services and one for the client counterparts.
## Installation
Go to the packages to see the details:
- Server is here on [Git](https://github.com/feathersjs-offline/owndata-ownnet/tree/main/packages/server) and here on [NPM](https://www.npmjs.com/package/@feathersjs-offline/server)
- Client is here on [Git](https://github.com/feathersjs-offline/owndata-ownnet/tree/main/packages/client) and here on [NPM](https://www.npmjs.com/package/@feathersjs-offline/client)
You'll need both to be able to a fully functional `own-data`or `own-net` offline-first implementation in your own app.
## Example
You can see an example showcasing Feathers offline-first [here](https://github.com/feathersjs-offline/simple-example)
## Documentation
You can read the original docs [here](https://auk.docs.feathersjs.com/guides/offline-first/readme.html) discussing the theories behind it all. The new and updated documentation is available [here](https://feathersjs-offline.github.io/docs).
> _Summary:_
>
> `own-data` / `own-net` are two related strategies implemented in Feathers Offline-first. Both strategies queues CRUD events for a wrapped service locally until the device have connection to the server, but to the user the CRUD events are executed immediately using optimistic mutation strategy.
>
> `own-data` will re-play all queued event to the server in the order they were performed in offline mode. This allows the the server to react on each event (mutation). It may, for example, run hooks which send emails on certain mutations.
>
> `own-net` on the other hand will only play the end result of all queued events for a given item (ie. row or document) to the server. If an item (document) is mutated 5 times only the result will reach the server when connection is established. If a record is patched and finally removed while still offline, the server will never see the mutations. The server may still react on each event (mutation), but bear in mind the changes are possibly only _net_ changes. `own-net` usually results in much shorter synchronization times and reduced traffic between client and server.
## License
Copyright (c) 2020
Licensed under the [MIT license](LICENSE).