@asyncapi/server-api

Server API providing official AsyncAPI tools.

: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
• Using it via Docker
• Development
• Deployment
  • How the GitHub workflow works
• Contribution
• Supported by
• Contributors

Requirements

• NodeJS >= 14

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

• Setup project by installing dependencies npm install
• Write code and tests.
• 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:

• Fork this repository.
• Create a DigitalOcean Personal Access Token with read and write permissions. For more information, see DigitalOcean's documentation.
• Run terraform init to initialize the Terraform project as can be seen here. This should be run being located at ./deployments/apps directory preferably.
• 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):

Maciej Urbańczyk 🚧 💻 📖 🐛 🤔 👀 ⚠️ 🚇 🧑‍🏫

David Pereira 🚧 💻 📖 🐛 🤔 👀 ⚠️ 🚇 🧑‍🏫

Sergio Moya 🚧 💻 📖 🐛 🤔 👀 ⚠️ 🚇 🧑‍🏫

Ritik Rawal 💻 📖

Everly Precia Suresh 💻 📖

Ashish Padhy 📖 🚇

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