https://github.com/apache/pouchdb
:kangaroo: - PouchDB is a pocket-sized database.
https://github.com/apache/pouchdb
couchdb database hacktoberfest javascript pouchdb
Last synced: 2 months ago
JSON representation
:kangaroo: - PouchDB is a pocket-sized database.
- Host: GitHub
- URL: https://github.com/apache/pouchdb
- Owner: apache
- License: apache-2.0
- Created: 2010-06-10T18:34:24.000Z (over 15 years ago)
- Default Branch: master
- Last Pushed: 2025-11-21T17:01:08.000Z (2 months ago)
- Last Synced: 2025-11-23T02:17:07.457Z (2 months ago)
- Topics: couchdb, database, hacktoberfest, javascript, pouchdb
- Language: JavaScript
- Homepage: https://pouchdb.com/
- Size: 120 MB
- Stars: 17,475
- Watchers: 256
- Forks: 1,499
- Open Issues: 190
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Notice: NOTICE
Awesome Lists containing this project
- awesome-repositories - apache/pouchdb - :kangaroo: - PouchDB is a pocket-sized database. (JavaScript)
- awesome-ccamel - apache/pouchdb - :kangaroo: - PouchDB is a pocket-sized database. (JavaScript)
- awesome - apache/pouchdb - :kangaroo: - PouchDB is a pocket-sized database. (JavaScript)
README
[PouchDB](https://pouchdb.com/) – The Database that Syncs!
=========
[](https://github.com/pouchdb/pouchdb/actions/workflows/ci.yml?query=branch%3Amaster) [](https://www.npmjs.com/package/pouchdb) [](https://www.jsdelivr.com/package/npm/pouchdb)
PouchDB is an open-source JavaScript database inspired by [Apache CouchDB](http://couchdb.apache.org/) that is designed to run well within the browser.
PouchDB was created to help web developers build applications that work as well offline as they do online.
Using PouchDB
-------------
To get started using PouchDB, check out the [web site](https://pouchdb.com) and [API documentation](https://pouchdb.com/api.html).
Getting Help
------------
The PouchDB community is active [in `#pouchdb` on the CouchDB Slack](https://join.slack.com/t/couchdb/shared_invite/zt-fa9zim0j-H04m4o_KcLdWeOxEAcwM8g), in [the Google Groups mailing list](https://groups.google.com/forum/#!forum/pouchdb), and [on StackOverflow](http://stackoverflow.com/questions/tagged/pouchdb). Or you can [mastodon @pouchdb](https://fosstodon.org/@pouchdb)!
If you think you've found a bug in PouchDB, please write a reproducible test case and file [a Github issue](https://github.com/pouchdb/pouchdb/issues).
Prerelease builds
----
If you like to live on the bleeding edge, you can build PouchDB from source using these steps:
git clone https://github.com/pouchdb/pouchdb.git
cd pouchdb
npm install
After running these steps, the browser build can be found in `packages/node_modules/pouchdb/dist/pouchdb.js`.
Changelog
----
PouchDB follows [semantic versioning](http://semver.org/). To see a changelog with all PouchDB releases, check out the [Github releases page](https://github.com/pouchdb/pouchdb/releases).
For a concise list of breaking changes, there's the [wiki list of breaking changes](https://github.com/pouchdb/pouchdb/wiki/Breaking-changes).
Keep in mind that PouchDB is auto-migrating, so a database created in 1.0.0 will still work if you open it in 4.0.0+. Any release containing a migration is clearly marked in the release notes.
Contributing
------------
We're always looking for new contributors! If you'd like to try your hand at writing code, writing documentation, designing the website, writing a blog post, or answering [questions on StackOverflow](http://stackoverflow.com/search?tab=newest&q=pouchdb), then we'd love to have your input.
If you have a pull request that you'd like to submit, please read the [contributing guide](https://github.com/pouchdb/pouchdb/blob/master/CONTRIBUTING.md) for info on style, commit message format, and other (slightly!) nitpicky things like that. PouchDB is heavily tested, so you'll also want to check out the [testing guide](https://github.com/pouchdb/pouchdb/blob/master/TESTING.md).