{"id":15394989,"url":"https://github.com/goto-bus-stop/keyv-firestore","last_synced_at":"2025-04-13T21:11:42.242Z","repository":{"id":34904108,"uuid":"188580479","full_name":"goto-bus-stop/keyv-firestore","owner":"goto-bus-stop","description":"Firebase Cloud Firestore backend for Keyv, the simple persistent key-value storage module","archived":false,"fork":false,"pushed_at":"2024-08-21T20:26:04.000Z","size":35,"stargazers_count":23,"open_issues_count":2,"forks_count":4,"subscribers_count":2,"default_branch":"default","last_synced_at":"2025-03-27T11:38:07.010Z","etag":null,"topics":["keyv","keyv-storage-adapter"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/goto-bus-stop.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-05-25T15:08:47.000Z","updated_at":"2024-12-12T17:43:47.000Z","dependencies_parsed_at":"2024-10-19T02:25:26.502Z","dependency_job_id":null,"html_url":"https://github.com/goto-bus-stop/keyv-firestore","commit_stats":{"total_commits":32,"total_committers":5,"mean_commits":6.4,"dds":0.375,"last_synced_commit":"6cec0993f21014e17a96992ef5a7ec873c70f698"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/goto-bus-stop%2Fkeyv-firestore","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/goto-bus-stop%2Fkeyv-firestore/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/goto-bus-stop%2Fkeyv-firestore/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/goto-bus-stop%2Fkeyv-firestore/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/goto-bus-stop","download_url":"https://codeload.github.com/goto-bus-stop/keyv-firestore/tar.gz/refs/heads/default","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248782260,"owners_count":21160717,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["keyv","keyv-storage-adapter"],"created_at":"2024-10-01T15:25:14.722Z","updated_at":"2025-04-13T21:11:42.219Z","avatar_url":"https://github.com/goto-bus-stop.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# keyv-firestore\n\nFirebase Cloud Firestore backend for [Keyv](https://github.com/lukechilds/keyv), the simple persistent key-value storage module\n\n[Install](#install) - [Usage](#usage) - [License: Apache-2.0](#license)\n\n[![npm][npm-image]][npm-url]\n[![ci][actions-image]][actions-url]\n[![standard][standard-image]][standard-url]\n\n[npm-image]: https://img.shields.io/npm/v/keyv-firestore.svg?style=flat-square\n[npm-url]: https://www.npmjs.com/package/keyv-firestore\n[actions-image]: https://img.shields.io/github/actions/workflow/status/goto-bus-stop/keyv-firestore/ci.yml?branch=default\u0026style=flat-square\n[actions-url]: https://github.com/goto-bus-stop/keyv-firestore/actions\n[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square\n[standard-url]: http://npm.im/standard\n\n## Compatibility\n\n`keyv-firestore` is tested with Keyv v3, v4, and v5, on Node.js 14 and up.\n\n## Install\n\n```\nnpm install keyv-firestore\n```\n\n## Usage\n\n`keyv-firestore` uses nested collections for namespaces and keys. A root collection contains keys for each namespace, and each namespace key contains a single collection that holds key/value pairs. The path to a specific key is `root-collection/namespace/namespace/key`.\n\n```js\nvar Keyv = require('keyv')\nvar KeyvFirestore = require('keyv-firestore')\n\nconst keyv = new Keyv({\n  store: new KeyvFirestore({\n    // the project id to use\n    projectId: 'my-firebase-project',\n    // REQUIRED: the root collection to store things in\n    collection: 'firestore-db-collection'\n  })\n})\n```\n\nYou can set the `GOOGLE_APPLICATION_CREDENTIALS` environment variable to configure credentials, or pass in a JavaScript object in the `credentials` option.\n\n```js\nconst keyv = new Keyv({\n  store: new KeyvFirestore({\n    projectId: 'my-firebase-project',\n    collection: 'firestore-db-collection',\n    credentials: require('./path/to/google-credentials.json')\n  })\n})\n```\n\n## Tests\n\nTo be able to run tests locally, put a `.google-credentials.json` file in this repository's root directory.\n\n## License\n\n[Apache-2.0](LICENSE.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgoto-bus-stop%2Fkeyv-firestore","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgoto-bus-stop%2Fkeyv-firestore","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgoto-bus-stop%2Fkeyv-firestore/lists"}