orkid-api v0.11.0

orkid-api

GraphQL API to monitor and manage Orkid task queue.

👋 This package comes bundled with Orkid UI. Users of Orkid UI don't have to use this separately.

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:

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:

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)

License

MIT

Related Projects

• orkid-node: Reliable and modern Redis based task queue for Node.js. Use this to produce and consume jobs.
• orkid-ui: Dashboard to monitor and manage Orkid task queue.