{"id":14976257,"url":"https://github.com/mugli/orkid-api","last_synced_at":"2025-10-27T18:30:51.964Z","repository":{"id":34308038,"uuid":"169692006","full_name":"mugli/orkid-api","owner":"mugli","description":"GraphQL API to  monitor and manage Orkid task queue ⚙️","archived":false,"fork":false,"pushed_at":"2023-01-04T22:12:08.000Z","size":2716,"stargazers_count":7,"open_issues_count":29,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-01T07:31:52.798Z","etag":null,"topics":["graphql","graphql-api","job-queue","monitoring","nodejs","orkid","queue","queue-manager","redis","task-queue"],"latest_commit_sha":null,"homepage":"","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/mugli.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2019-02-08T06:00:29.000Z","updated_at":"2023-03-04T05:03:09.000Z","dependencies_parsed_at":"2023-01-15T06:13:46.493Z","dependency_job_id":null,"html_url":"https://github.com/mugli/orkid-api","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mugli%2Forkid-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mugli%2Forkid-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mugli%2Forkid-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mugli%2Forkid-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mugli","download_url":"https://codeload.github.com/mugli/orkid-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238536145,"owners_count":19488666,"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","graphql-api","job-queue","monitoring","nodejs","orkid","queue","queue-manager","redis","task-queue"],"created_at":"2024-09-24T13:53:35.172Z","updated_at":"2025-10-27T18:30:51.606Z","avatar_url":"https://github.com/mugli.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# orkid-api\n\n[![NPM version](https://img.shields.io/npm/v/orkid-api.svg)](https://www.npmjs.com/package/orkid-api)\n[![Build Status](https://img.shields.io/circleci/build/github/mugli/orkid-api/master?token=26f2e664d6f594682298e4fc4e194228665bebc9)](https://circleci.com/gh/mugli/orkid-api)\n![Dependencies](https://img.shields.io/david/mugli/orkid-api.svg?style=flat)\n![Dev Dependencies](https://img.shields.io/david/dev/mugli/orkid-api.svg?style=flat)\n![Required Node Version](https://img.shields.io/node/v/orkid-api.svg?style=flat)\n![License](https://img.shields.io/npm/l/orkid-api.svg?style=flat)\n\nGraphQL API to monitor and manage **[Orkid task queue](https://github.com/mugli/orkid-node)**.\n\n---\n\n👋 **This package comes bundled with Orkid UI.**\nUsers of [Orkid UI](https://github.com/mugli/orkid-ui) don't have to use this separately.\n\n---\n\n![screenshot](https://raw.githubusercontent.com/mugli/orkid-api/master/screenshot.png)\n\n---\n\n## Development\n\n### Minimum Requirements\n\n- Node.js \u003e= 10\n- Redis \u003e= 5\n\n### Seed Initial Data\n\nYou don't have to have Orkid running so that the API can return data from Redis for development purpose. The seed script generates necessary data in redis.\n\nMake sure `redis-server` is running. Then:\n\n```sh\nnpm run flush-and-seed\n```\n\n**Warning: It will DELETE all existing data in Redis!**\n\nRunning the command will ask if it is ok to delete existing data and proceed with seed.\n\n\u003e All data in your redis sever will be cleared. Proceed? (y/N)\n\nEnter `y` to continue.\n\n### Start the GraphQL API Server\n\nMake sure `redis-server` is running. Then:\n\n```sh\nnpm run dev\n```\n\nIt should show:\n\n\u003e Orkid API ready at http://localhost:4100/api/graphql\n\nOpen the URL in the browser to launch GraphQL playground (showed in the screenshot above).\n\n---\n\n## Maintainer(s)\n\n- Mehdi Hasan Khan (Twitter: [@MehdiHK](https://twitter.com/MehdiHK))\n\n---\n\n## License\n\nMIT\n\n---\n\n### Related Projects\n\n- [orkid-node](https://github.com/mugli/orkid-node): Reliable and modern Redis based task queue for Node.js. Use this to produce and consume jobs.\n- [orkid-ui](https://github.com/mugli/orkid-ui): Dashboard to monitor and manage Orkid task queue.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmugli%2Forkid-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmugli%2Forkid-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmugli%2Forkid-api/lists"}