GithubHelp home page GithubHelp logo

pouchdb's Introduction

About PouchDB

PouchDB was written to help web developers build applications that work as well offline as well as they do online, applications save data locally so the user can use all the features of an app even while offline and synchronise the data between clients so they have up to date data wherever they go.

PouchDB is a free open source project, written in Javascript by these wonderful contributors and inspired by Apache CouchDB. If you want to get involved then check out the contributing guide

Browser Support

PouchDB uses various backends so it can work across various browsers and in Node.js. It uses IndexedDB in Firefox and Chrome, WebSQL in Safari and Opera and LevelDB in Node.js. It is currently tested in:

If your application requires support for Internet Explorer below version 10, it is possible to use an online CouchDB as a fallback, however it will not work offline.

Current Status

PouchDB in the browser currently beta release software, it is extensively tested and the functionality implemented is known to be stable however you may find bugs in lesser used parts of the API. The API is currently stable with no known changes and you will be able to upgrade PouchDB without losing data. We are currently working towards a stable release of PouchDB.

PouchDB in Node.js is currently alpha and an upgrade to the library can break current databases. It is however possible to upgrade by replicating data across different versions to manually upgrade.

Installing

PouchDB is designed to be a minimal library that is suitable for mobile devices, to start using PouchDB in your website you simply Download and include it in your webpage.

<script src="pouchdb-nightly.min.js"></script>

If you are using Node.js then

$ npm install pouchdb

For a HTTP API to PouchDB check out PouchDB Server

Using PouchDB

To get started using PouchDB check out our Getting Started Tutorial and the API Documentation.

pouchdb's People

Contributors

adampolak avatar axemclion avatar benrudolph avatar briantoth avatar calvinmetcalf avatar chendricks avatar chesles avatar chunmun avatar crodjer avatar daleharvey avatar gabrielmancini avatar howonlee avatar jamesjwood avatar jamesmayes avatar jo avatar marten-de-vries avatar max-mapper avatar mikeal avatar natevw avatar neojski avatar nick-thompson avatar pixelcort avatar redtrumpet avatar ryanramage avatar tilgovi avatar trisapeace avatar trokster avatar vmx avatar ymichael avatar zichun avatar

Watchers

 avatar  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.