npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

orkid-api

v0.11.0

Published

GraphQL API to Monitoring and Manage Orkid Task Queue

Downloads

29

Readme

orkid-api

NPM version Build Status Dependencies Dev Dependencies Required Node Version License

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.


screenshot


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)


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.