pouchdb README

The project's README from github.com/apache/pouchdb. As one markdown file: README.md.

Apache PouchDB – The Database that Syncs!

Build Status npm version jsDelivr Hits

Apache PouchDB is an open-source JavaScript database inspired by Apache CouchDB 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.

Apache PouchDB is currently undergoing Incubation at the Apache Software Foundation. Read the ASF Disclaimer for incubator projects.

Using PouchDB

To get started using PouchDB, check out the web site and API documentation.

Getting Help

The PouchDB community is active in #pouchdb on the CouchDB Slack, in the Google Groups mailing list, and on StackOverflow. Or you can mastodon @pouchdb!

If you think you've found a bug in PouchDB, please write a reproducible test case and file a Github issue.

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. To see a changelog with all PouchDB releases, check out the Github releases page.

For a concise list of breaking changes, there's the wiki list of 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, 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 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.

The pouchdb.com Website

The documentation website at pouchdb.com is also part of this repo, in the /docs folder. It has its own /docs/WEBSITE_README.md

Website deployment happens automatically once the changes land in master.

pouchdb (apache/pouchdb)

Searching Database…

17.6K ·GitHub
Pouchdb
这是什么？PouchDB 是一个开源的 JavaScript 数据库，灵感来自 Apache CouchDB，专为在浏览器中良好运行而设计，让 Web 开发者能够构建在离线和在线状态下都能工作的应用。
它是库还是独立的数据库服务器？它是一个嵌入到你的应用中（浏览器或 Node.js）的 JavaScript 库，而不是单独的服务器进程，不过它可以与真正的 CouchDB 服务器同步。
怎么把它添加到项目里？通过 npm 安装并导入，或者用 git clone 获取源码后执行 npm install 自行构建；浏览器版本的构建输出文件位于 packages/node_modules/pouchdb/dist/pouchdb.js。
它底层依赖什么来存储数据？PouchDB 的依赖包括 LevelDOWN/LevelUP 等存储后端以及 WebSQL 绑定，它会根据运行环境（浏览器还是 Node）选择使用哪一种。
升级后我的旧数据库还能用吗？能。PouchDB 会自动迁移，因此在 1.0.0 版本创建的数据库，在 4.0.0 及以上版本中打开仍然可用；凡是包含迁移的版本，都会在发行说明中明确标注。
它真的能离线工作吗？能。离线支持正是 PouchDB 的核心目的，它的设计目标是让应用在离线和在线时同样好用，并在网络恢复后同步变更。
PouchDB 会和服务器同步，还是纯本地的？它的设计目标是与 Apache CouchDB（或兼容的服务器）同步，因此它被描述为“能同步的数据库”，本地数据可以与远程 CouchDB 实例相互复制。
为什么专门叫 Apache PouchDB？PouchDB 目前正处于 Apache 软件基金会（ASF）的孵化阶段，并在此过程中遵循 ASF 的治理方式和许可协议（Apache-2.0）。
文档在哪里？完整的 API 文档和指南位于 pouchdb.com 网站上，其源码也包含在本仓库的 /docs 文件夹中。
What are similar projects?rxdb, WatermelonDB, gun, automerge-classic, instant, date-fns, validator.js, reticle
Which topics is it in?sync, npm-package, offline-first, javascript-library, local-first, hacktoberfest, database, npm, apache-2.0, nodejs, library, javascript
Creator
apache
Size
124.9 MB
Stars
17.6K
Updated
CommitAug 25Release9.0.0Jun 21
Age
16y
Commits · 90 Days