https://github.com/mugli/orkid-api

GraphQL API to monitor and manage Orkid task queue ⚙️
https://github.com/mugli/orkid-api

graphql graphql-api job-queue monitoring nodejs orkid queue queue-manager redis task-queue

Last synced: about 1 month ago
JSON representation

GraphQL API to monitor and manage Orkid task queue ⚙️

• Host: GitHub
• URL: https://github.com/mugli/orkid-api
• Owner: mugli
• License: mit
• Created: 2019-02-08T06:00:29.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-04T22:12:08.000Z (almost 2 years ago)
• Last Synced: 2024-09-28T21:43:11.404Z (about 2 months ago)
• Topics: graphql, graphql-api, job-queue, monitoring, nodejs, orkid, queue, queue-manager, redis, task-queue
• Language: JavaScript
• Homepage:
• Size: 2.59 MB
• Stars: 7
• Watchers: 1
• Forks: 1
• Open Issues: 29
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# orkid-api

[![NPM version](https://img.shields.io/npm/v/orkid-api.svg)](https://www.npmjs.com/package/orkid-api)

[![Build Status](https://img.shields.io/circleci/build/github/mugli/orkid-api/master?token=26f2e664d6f594682298e4fc4e194228665bebc9)](https://circleci.com/gh/mugli/orkid-api)

![Dependencies](https://img.shields.io/david/mugli/orkid-api.svg?style=flat)

![Dev Dependencies](https://img.shields.io/david/dev/mugli/orkid-api.svg?style=flat)

![Required Node Version](https://img.shields.io/node/v/orkid-api.svg?style=flat)

![License](https://img.shields.io/npm/l/orkid-api.svg?style=flat)

GraphQL API to monitor and manage **[Orkid task queue](https://github.com/mugli/orkid-node)**.

---

👋 **This package comes bundled with Orkid UI.**

Users of [Orkid UI](https://github.com/mugli/orkid-ui) don't have to use this separately.

---

![screenshot](https://raw.githubusercontent.com/mugli/orkid-api/master/screenshot.png)

---

## Development

### Minimum Requirements

- Node.js >= 10

- Redis >= 5

### Seed Initial Data

You 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.

Make sure `redis-server` is running. Then:

```sh

npm run flush-and-seed

```

**Warning: It will DELETE all existing data in Redis!**

Running the command will ask if it is ok to delete existing data and proceed with seed.

> All data in your redis sever will be cleared. Proceed? (y/N)

Enter `y` to continue.

### Start the GraphQL API Server

Make sure `redis-server` is running. Then:

```sh

npm run dev

```

It should show:

> Orkid API ready at http://localhost:4100/api/graphql

Open the URL in the browser to launch GraphQL playground (showed in the screenshot above).

---

## Maintainer(s)

- Mehdi Hasan Khan (Twitter: [@MehdiHK](https://twitter.com/MehdiHK))

---

## License

MIT

---

### Related Projects

- [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.

- [orkid-ui](https://github.com/mugli/orkid-ui): Dashboard to monitor and manage Orkid task queue.