What is this?
PouchDB is an open-source JavaScript database inspired by Apache CouchDB that is designed to run well within the browser, letting web developers build apps that work offline as well as online.
PouchDB is an open-source JavaScript database inspired by Apache CouchDB that is designed to run well within the browser, letting web developers build apps that work offline as well as online.Is it a library or a standalone database server?It's a JavaScript library you embed in your app (browser or Node.js) rather than a separate server process, though it can sync with a real CouchDB server.
It's a JavaScript library you embed in your app (browser or Node.js) rather than a separate server process, though it can sync with a real CouchDB server.How do I add it to a project?Install via npm and import it, or build it yourself from source with git clone, then npm install; the browser build output lands in packages/node_modules/pouchdb/dist/pouchdb.js.
Install via npm and import it, or build it yourself from source with git clone, then npm install; the browser build output lands in packages/node_modules/pouchdb/dist/pouchdb.js.What does it rely on under the hood for storage?PouchDB's dependencies include storage backends like LevelDOWN/LevelUP and WebSQL bindings, which it uses depending on the environment (browser vs Node).
PouchDB's dependencies include storage backends like LevelDOWN/LevelUP and WebSQL bindings, which it uses depending on the environment (browser vs Node).Will my old databases still work after upgrading?Yes, PouchDB is auto-migrating, so a database created in 1.0.0 still works when opened in 4.0.0+; any release with a migration is clearly noted in release notes.
Yes, PouchDB is auto-migrating, so a database created in 1.0.0 still works when opened in 4.0.0+; any release with a migration is clearly noted in release notes.Does it really work offline?Yes, offline support is the core purpose of PouchDB — it's built so apps work as well offline as online, syncing changes when connectivity returns.
Yes, offline support is the core purpose of PouchDB — it's built so apps work as well offline as online, syncing changes when connectivity returns.Does PouchDB sync with a server, or is it purely local?It's designed to sync with Apache CouchDB (or compatible servers), which is why it's described as 'the database that syncs' — local data replicates to and from a remote CouchDB instance.
It's designed to sync with Apache CouchDB (or compatible servers), which is why it's described as 'the database that syncs' — local data replicates to and from a remote CouchDB instance.Why 'Apache' PouchDB specifically?PouchDB is undergoing Incubation at the Apache Software Foundation, following ASF governance and licensing (Apache-2.0) as part of that process.
PouchDB is undergoing Incubation at the Apache Software Foundation, following ASF governance and licensing (Apache-2.0) as part of that process.Where is the documentation?Full API docs and guides live on the pouchdb.com website, whose source is also included in this repo under the /docs folder.
Full API docs and guides live on the pouchdb.com website, whose source is also included in this repo under the /docs folder.What are similar projects?rxdb, WatermelonDB, gun, automerge-classic, instant, date-fns, validator.js, reticle
rxdb, WatermelonDB, gun, automerge-classic, instant, date-fns, validator.js, reticleWhich topics is it in?sync, npm-package, offline-first, javascript-library, local-first, hacktoberfest, database, npm, apache-2.0, nodejs, library, javascript
sync, npm-package, offline-first, javascript-library, local-first, hacktoberfest, database, npm, apache-2.0, nodejs, library, javascript