JSPM – @asyncapi/studio@0.16.1

Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@asyncapi/studio) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

One place that allows you to develop an AsyncAPI document, validate it, convert it to the latest version, preview the documentation and visualize the events flow.

📢 ATTENTION:

This project is still under development and has not reached version 1.0.0 yet. This means that its API/styling/features 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
- Spin up Gitpod
Contribution
Contributors ✨

Requirements

NodeJS >= 14

Using it locally

Run:

npm install
npm start

and then go to http://localhost:3000.

Using it via Docker

Run:

docker run -it -p 8000:80 asyncapi/studio

and then go to http://localhost:8000.

The asyncapi/studio image is based on the official nginx image. Please refer to the Nginx documentation to learn how to e.g. pass a custom nginx configuration or plug in additional volumes.

In some hosting scenarios (e.g. Docker Compose, Kubernetes) the container might not be exposed at the root path of the host. Set the environment variable BASE_URL to let AsyncAPI Studio know from where to resolve static assets:

docker run -it -p 8000:80 -e BASE_URL=/a/custom/path asyncapi/studio

Studio is also available as a Docker Desktop Extension. For more information, check the related repository.

Development

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

Spin up Gitpod

In order to prepare and spin up a Gitpod dev environment for our project, we configured our workspace through a .gitpod.yml file.

To spin up a Gitpod, go to http://gitpod.io/#https://github.com/asyncapi/studio.

Contribution

Read CONTRIBUTING guide.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

_{Maciej Urbańczyk} 🚧 💻 📖 🐛 🤔 👀 🎨 ⚠️ 🚇 🧑‍🏫	_{Fran Méndez} 🚧 💻 📖 🐛 🤔 👀 🎨 ⚠️ 🚇 🧑‍🏫	_{David Boyne} 🚧 💻 📖 🐛 🤔 👀 🎨 ⚠️ 🧑‍🏫	_{Missy Turco} 🚧 💻 🤔 👀 🎨 🧑‍🏫	_{Florian Greinacher} 💻 🚇 🐛 📖	_{Ritik Rawal} 💻	_Samriddhi 💻
_{Pauline P. Narvas} 💻 🚇 📖	_{Jonas Lagoni} 🤔 💬 👀	_{Sergio Moya} 🤔 💬	_{David Pereira} 🤔 💬	_{Nawed Ali} 💻 🐛	_{Viacheslav Turovskyi} 💻

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