{"id":22257075,"url":"https://github.com/avishwakarma/dgraph-koa","last_synced_at":"2025-06-19T08:09:27.792Z","repository":{"id":148740848,"uuid":"169306871","full_name":"avishwakarma/dgraph-koa","owner":"avishwakarma","description":"A Graphql Application using Dgraph and Koa","archived":false,"fork":false,"pushed_at":"2019-02-05T21:18:34.000Z","size":23,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-01T19:12:35.231Z","etag":null,"topics":["dgraph","dgraph-graphql-koa"],"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/avishwakarma.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,"governance":null}},"created_at":"2019-02-05T20:22:18.000Z","updated_at":"2021-10-31T05:19:23.000Z","dependencies_parsed_at":"2023-05-28T19:45:26.395Z","dependency_job_id":null,"html_url":"https://github.com/avishwakarma/dgraph-koa","commit_stats":null,"previous_names":["ashokvishwakarma/dgraph-koa"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/avishwakarma/dgraph-koa","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/avishwakarma%2Fdgraph-koa","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/avishwakarma%2Fdgraph-koa/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/avishwakarma%2Fdgraph-koa/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/avishwakarma%2Fdgraph-koa/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/avishwakarma","download_url":"https://codeload.github.com/avishwakarma/dgraph-koa/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/avishwakarma%2Fdgraph-koa/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260713351,"owners_count":23050827,"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":["dgraph","dgraph-graphql-koa"],"created_at":"2024-12-03T08:09:32.490Z","updated_at":"2025-06-19T08:09:22.777Z","avatar_url":"https://github.com/avishwakarma.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DgraphKoa\nBuild a GraphQL application using Dgraph and Koa\n\n\n## Introduction\n\nDgraph is a distributed, highly available graph database that uses a language\nsimilar to GraphQL to query and mutate data. Unlike GraphQL, Dgraph only defines\nschema for predicates (properties) within the graph; there is no concept of\ncomplex types or groups of properties. Because of this it is straight forward to\nstore any GraphQL schema in Dgraph provided a few restrictions are met.\n\nGiven a GraphQL schema, DgraphKoa can do four things:\n\n1. Generate a GraphQL-JS schema that maps GraphQL queries to Dgraph queries\n2. Transform Dgraph responses into GraphQL responses (including support for the\n   relay connection specification)\n3. Generate defaults for create/update/delete/query operations (with filtering,\n   ordering and nested create/update mutations)\n4. Configure Dgraph's schema with types and indexes each property.\n\n\n## Getting Started\n\nThe [example](https://github.com/ashokvishwakarma/dgraph-koa/tree/master/example) describes\nbasic usage. First, install dependencies:\n\n```sh\nnpm install\n```\n\n## Using DgraphKoa\n\nInstall DgraphQL from npm\n\n\n```sh\nnpm install dgraph-koa\n```\n\nThe entry point to the library is `Server`\n\n```javascript\nimport { Server } from 'dgraph-koa'\n\nconst schema = `\ntype Person {\n  id: ID!\n  name: String @filter(types: [EQUALITY])\n  children: [Person!]! @reverse(name: \"parents\")\n  parents: [Person!]! @reverse(name: \"children\")\n}`\n\n(async () =\u003e {\n  const server = new Server({\n    debug: true,\n    relay: false,\n    graphiql: true, // enable Graphiql UI\n    graphiqlUrl: '/graphql', // URL for graphql middleware\n    dgraph: {\n      uri: 'localhost:9080' // Dgraph database uri\n    }\n  });\n\n  server.updateSchema(schema);\n\n  server.listen(4000, '0.0.0.0', () =\u003e {\n    console.log(\"Server started at http://0.0.0.0:4000\")\n  });\n})();\n```\n\n### config\nDgraphKoa config passed in `Server constructor`\n\n```\ndebug: boolean // default true\nrelay: boolean // default false\ngraphiql: boolean // default true\ngraphiqlUrl: string // degault /graphql\ndgraph: {\n  url: string // default localhost:9080,\n  credentials: grpc // default grpc.credentials.createInsecure()\n}\n```\n\n### Adding other routes\nThe DgraphKoa allow you to add more middlewares and routing rules into the Koa application\n\n```javascript\nconst server = new Server(...config);\n\n// server.app actual Koa app\n\nserver.app.use(\n  // middleware\n);\n\nserver.use(\n  // routing rules\n);\n\nserver.listen(\n  // port\n  // host\n  // callback\n)\n```\n\n### Special Thanks\n[David Peek](https://github.com/dpeek) for his [dgaphql](https://github.com/dpeek/dgraphql) github repo.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Favishwakarma%2Fdgraph-koa","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Favishwakarma%2Fdgraph-koa","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Favishwakarma%2Fdgraph-koa/lists"}