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

@asyncapi/server-api

v0.16.22

Published

Server API providing official AsyncAPI tools

Downloads

47

Readme

AsyncAPI Server API

Server API providing official AsyncAPI tools.

All Contributors


:loudspeaker: ATTENTION:

This package is still under development and has not published and reached version 1.0.0 yet. This means that its API may contain breaking changes until we're able to deploy the first stable version and begin semantic versioning.


Requirements

Using it locally

Run:

npm install
npm run start:prod

server is ready to use on http://localhost:80.

Using it via Docker

Run:

docker run -it -p 80:80 asyncapi/server-api

server is ready to use on http://localhost:80.

Development

  1. Setup project by installing dependencies npm install
  2. Write code and tests.
  3. Make sure all tests pass npm test

Deployment

This project is deployed to DigitalOcean App Platform using Terraform and GitHub Actions. To deploy it to your own account, follow these steps:

  1. Fork this repository.
  2. Create a DigitalOcean Personal Access Token with read and write permissions. For more information, see DigitalOcean's documentation.
  3. Run terraform init to initialize the Terraform project as can be seen here. This should be run being located at ./deployments/apps directory preferably.
  4. Run terraform apply to create the necessary infrastructure.

[!NOTE] You need to export the following environment variables before running terraform apply:

  • DIGITALOCEAN_ACCESS_TOKEN: Your DigitalOcean Personal Access Token.

How the GitHub workflow works

The GitHub workflow is triggered when a new tag is pushed to the repository. It will build a new Docker image and push it to the Docker Hub repository. Then the DigitalOcean App Platform GitHub Action updates the application with the new image.

Contribution

Read CONTRIBUTING guide.

Supported by

Contributors

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!