{"id":16225415,"url":"https://github.com/mikebild/graphql-pouch","last_synced_at":"2025-04-09T12:04:03.640Z","repository":{"id":9893536,"uuid":"63133028","full_name":"MikeBild/graphql-pouch","owner":"MikeBild","description":"GraphQL runtime using PouchDB","archived":false,"fork":false,"pushed_at":"2022-12-06T15:21:26.000Z","size":1149,"stargazers_count":204,"open_issues_count":36,"forks_count":13,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-04-09T12:02:42.353Z","etag":null,"topics":["graphql","pouchdb"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MikeBild.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-07-12T06:37:28.000Z","updated_at":"2024-01-08T16:00:19.000Z","dependencies_parsed_at":"2023-01-13T16:24:10.334Z","dependency_job_id":null,"html_url":"https://github.com/MikeBild/graphql-pouch","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MikeBild%2Fgraphql-pouch","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MikeBild%2Fgraphql-pouch/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MikeBild%2Fgraphql-pouch/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MikeBild%2Fgraphql-pouch/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MikeBild","download_url":"https://codeload.github.com/MikeBild/graphql-pouch/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248036064,"owners_count":21037092,"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":["graphql","pouchdb"],"created_at":"2024-10-10T12:44:58.483Z","updated_at":"2025-04-09T12:04:03.603Z","avatar_url":"https://github.com/MikeBild.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GraphQL-API runtime on top of PouchDB\n\n[![Build Status](https://travis-ci.org/MikeBild/graphql-pouch.svg?branch=master)](https://travis-ci.org/MikeBild/graphql-pouch)\n[![Package on npm](https://img.shields.io/npm/v/graphql-pouch.svg?style=flat)](https://www.npmjs.com/package/graphql-pouch)\n\n*A GraphQL-API runtime on top of PouchDB created by GraphQL shorthand notation as a self contained service with CouchDB synchronization.*\n\n__Objectives - evaluating for your project__\n\n* Frontend-First-Driven approach without backend/database migrations\n* Friendly GraphQL shorthand notation spec to create typed data model definitions fast and easy\n* Self-contained // no infrastructure dependencies // no lock in\n* Customizable for seamless integration of existing resources\n\n## Usage\nFirst install using npm:\n\n```bash\nnpm install -g graphql-pouch\n```\n\nand then just run it!\n\n```bash\ngraphql-pouch\n```\n\nFor more information run:\n\n```bash\ngraphql-pouch -h\n```\n\n##GraphiQL UI for development becomes standard\n\n[GraphiQL](https://github.com/graphql/graphiql) is a awesome web based tool by Facebook to let you interactively explore your data and your API. When development mode is enabled in GraphQL-Pouch, the GraphiQL interface will be automatically displayed at your GraphQL endpoint.\n\n__Example__\n\n```bash\ngraphql-pouch --development\n```\n\n```bash\nListen on port 3000\nCouchDB sync URL: none\nRelay enabled: true\nDevelopment mode: true\nJWT-Authentication: false\n\nSupported GraphQL schemas:\ncms initialized and running - http://127.0.0.1:3000/graphql/cms\n```\n\nNavigate to the URL printed to your console after starting GraphQL-Pouch and use GraphiQL to fetch your data. When you want to use GraphQL-Pouch in production mode, the [GraphiQL-App](https://github.com/skevy/graphiql-app) is ideally suited.\n\n## GraphQL and Relay\n\nCheck out the [CMS example](https://github.com/MikeBild/graphql-pouch/tree/master/example/cms-relay) for a demo of GraphQL-Pouch, Relay and React in action.\n\n## Benefits\n\nGraphQL-Pouch uses the joint benefits of PouchDB and GraphQL to provide a number of key benefits.\n\n* 100% GraphQL compliant (supports pure GraphQL mode)\n* [100% Relay](doc/using-relay.md) compliant\n* [Command Line Interface](doc/CLI.md)\n* [JWT Authentication support](doc/jwt-authentication.md)\n* [Custom GraphQL-Queries and Mutations](doc/custom-functions.md) via JavaScript functions\n* Fully documented API and [GraphiQL-UI](https://github.com/graphql/graphiql) for development\n* [Serves multiple GraphQL schemas](doc/multi-graphql.md)\n* [Using GraphQL-Pouch as a NPM-Module](doc/npm-module.md)\n* [Completely self contained with Master/Master Replication](doc/replication.md)\n* Supports relationships, types, comments, pagination, and more providing by GraphQL, PouchDB and CouchDB\n* Serves static files for e.g. React-Application hosting\n\n## Roadmap\nIn the future, things that GraphQL-Pouch will include:\n\n* HTTPS Support\n* Mock/Fake data results\n* Runtime traceability using resolver timings\n* Role based authorization\n* MongoDB query language inspired subselections\n* DataLoader for batching and caching optimization\n* Subscriptions using PouchDB change notifications\n\nand, of course:\n\n* better documentation\n* better validation and error messages\n* better debug logs\n* more tests\n* more examples\n\n## Run Tests\n\n```\nnpm install\nnpm test\n```\n\n## Development\n\n```\nnpm run dev\n```\n\n## Contributors\nCheck them out [here](https://github.com/MikeBild/graphql-pouch/graphs/contributors)\n\n## Issue Reporting\n\nIf you have found a bug or if you have a feature request, please report them at this repository issues section. Please do not report security vulnerabilities on the public [GitHub issue tracker](https://github.com/MikeBild/graphql-pouch/issues).\n\n## License\n\nThis project is licensed under the MIT license. See the [LICENSE](LICENSE) file for more info.\n\n## Thanks\n\nYou like this GraphQL server and you want to see what coming next? Follow me on Twitter [`@mikebild`](https://twitter.com/mikebild).\n\nEnjoy!\n\n## Credits\n\nThanks to [Matthew Mueller](https://github.com/matthewmueller) for his initial work on [graph.ql](https://github.com/matthewmueller/graph.ql) which laid the groundwork for the GraphQL shorthand notation parser module.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmikebild%2Fgraphql-pouch","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmikebild%2Fgraphql-pouch","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmikebild%2Fgraphql-pouch/lists"}