EventBridge Atlas

EventBridge Atlas

  • Docs
  • GitHub

›Getting Started

Introduction

  • Motivation
  • How it works

Getting Started

  • Installation
  • Setup
  • Populating your Metadata
  • Running with slate
  • Running with asyncapi
  • Running with docuowl
  • Running with flow (node diagram)

Customising

  • Adding metadata to schema

Parsers

  • What are parsers?
  • Slate Parser
  • Asyncapi Parser
  • Docuowl Parser
  • Flow Parser

Releases

  • v1.1.0
  • v1.0.0
  • v0.4
  • v0.3
  • v0.2
  • v0.1

Other Projects

  • awsicons.dev
  • mockit

Contributing

  • Contributing
Edit

Running with Flow (node diagram)

Outputting flow (node diagram) Docs

Flow

To run the application you will need to run

npm run build:flow

This will download the required information from AWS and run your data through the flow parser.

The parser will generate the documentation for you. Simple!

After this process is complete you can run this next command to start the server on your machine.

npm run start-server -- docs-html/flow

That's it!

Remember to have your .env file setup. If you run into any problems feel free to reach out.

Customise your data and events

Now (hopefully) you should have your events displayed and documented! Awesome.

Now you can customise your events further, read customising events.

Last updated on 5/3/2021 by David Boyne
← Running with docuowlAdding metadata to schema →
Status ChecksStar eventbridge-atlas