ritik307 / studio

Visually design your AsyncAPI files and event-driven architecture.

Studio

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
• Development
  • Spin up Gitpod
• Contribution
• Contributors ✨

Requirements

• NodeJS >= 14

Using it locally

Run:

npm install
npm start

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

Development

1. Setup project by installing dependencies npm install
2. Write code and tests.
3. 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 🐛 💻 📖 🤔 🚧 💬 ⚠️ 👀

Jonas Lagoni 🤔 💬 👀

Fran Méndez 💻 📖 🤔 🚧 💬 ⚠️ 👀

David Boyne 💻 📖 🤔 🚧 💬 ⚠️ 👀

Sergio Moya 🤔 💬

David 🤔 💬

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