https://github.com/kinto/kinto.js

An Offline-First JavaScript Client for Kinto.
https://github.com/kinto/kinto.js

cache client hacktoberfest http kinto offline offline-first sync synchronization

Last synced: about 3 hours ago
JSON representation

An Offline-First JavaScript Client for Kinto.

• Host: GitHub
• URL: https://github.com/kinto/kinto.js
• Owner: Kinto
• License: other
• Created: 2015-05-20T22:46:31.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-10-18T09:27:52.000Z (about 1 month ago)
• Last Synced: 2024-10-31T19:56:04.199Z (17 days ago)
• Topics: cache, client, hacktoberfest, http, kinto, offline, offline-first, sync, synchronization
• Language: TypeScript
• Homepage: http://kintojs.readthedocs.io/
• Size: 16.4 MB
• Stars: 318
• Watchers: 13
• Forks: 72
• Open Issues: 66
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: docs/contributing.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Kinto.js

[![Greenkeeper badge](https://badges.greenkeeper.io/Kinto/kinto.js.svg)](https://greenkeeper.io/)

[![Build Status](https://travis-ci.org/Kinto/kinto.js.svg?branch=master)](https://travis-ci.org/Kinto/kinto.js) [![Coverage Status](https://coveralls.io/repos/Kinto/kinto.js/badge.svg?branch=master&service=github)](https://coveralls.io/github/Kinto/kinto.js?branch=master) [![](https://readthedocs.org/projects/kintojs/badge/?version=latest)](http://kintojs.readthedocs.io/)

An [Offline-First](http://offlinefirst.org/) JavaScript client for [Kinto](https://kinto.readthedocs.io/).

> Note: This library also includes a pure JS HTTP client for Kinto. You can learn more in [the docs](https://kintojs.readthedocs.io/en/latest/http/).

The idea is to persist data locally in the browser by default, then synchronizing them with the server explicitly when connectivity is guaranteed:

```js

const kinto = new Kinto({ remote: "https://demo.kinto-storage.org/v1/" });

const posts = kinto.collection("posts");

// Create and store a new post in the browser local database

await posts.create({ title: "first post" });

// Publish all local data to the server, import remote changes

await posts.sync();

```

## Documentation

- [Installation](https://kintojs.readthedocs.io/en/latest/installation/)

- [Tutorial](https://kintojs.readthedocs.io/en/latest/tutorial/)

- [Api documentation](https://kintojs.readthedocs.io/en/latest/api/)

- [Extending Kinto.js](https://kintojs.readthedocs.io/en/latest/extending/)

- [Upgrading Kinto.js](https://kintojs.readthedocs.io/en/latest/upgrading/)

- [Known limitations](https://kintojs.readthedocs.io/en/latest/limitations/)

- [Contributing](https://kintojs.readthedocs.io/en/latest/contributing/)