eventbridge-atlas - GitLite

KO | EN

gitlite — search

#typescript #llm #go #golang #android #machine-learning #linux #macos #java #windows #kubernetes #awesome-list #openai #open-source

eventbridge-atlas

(★ 199)

Open-source tool to document, discover, and share your Amazon EventBridge schemas.

File Explorer

Download Latest Version (.zip)

- FUNDING.yml
- INSTRUCTIONS.md
- architecture-2.png
- architecture.png
- asyncapi-example.png
- docuowl-example.png
- docuowl.png
- full-app-screenshot.png
- slate-example.png
- - Registry.js
  - Schema.js
- - index.js
- - aws.js
  - exec.js
  - generate-metadata-templates.js
- index.js
.babelrc
.dockerignore
.env-example
.gitignore
LICENCE
package.json
prettier.config.js
README.md

# Installation Guide

1. Get the code

git clone https://github.com/boyney123/eventbridge-atlas

Downloads the entire project code from GitHub to your computer.

cd eventbridge-atlas

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.

docker build -f src/parsers/docuowl/utils/Dockerfile.local -t eventbridge-atlas .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 eventbridge-atlas

Runs the built image as an actual container.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Node.js

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<div align="center">

<h2>EventBridge Atlas 🗺</h2>
<p>Document, Discover and Share Amazon EventBridge Schemas.</>

[![MIT License][license-badge]][license]
[![PRs Welcome][prs-badge]][prs]

[![Watch on GitHub][github-watch-badge]][github-watch]
[![Star on GitHub][github-star-badge]][github-star]

<hr />

<img alt="header" src="./images/full-app-screenshot.png" />

<h3>Features: Parses EventBridge schemas into documentation solutions, shows rules matched to your events, add metadata to each event property, support slate, AsyncAPI and docuowl output, and more...</h3>

[Read the Docs](https://eventbridge-atlas.netlify.app/) | [Edit the Docs](https://github.com/boyney123/eventbridge-atlas-docs)

</div>

<hr/>

# The problem

Event-Driven Architectures allow us to scale, be agile and keep our architecture decoupled. Ultimately I believe they help us work more efficiently.

When starting off with Event-Driven Architectures we spend time discovering our core business events, writing code to match them and maintain versions going forward.

Over a period of time more events are added to our domain, requirements change, and our architecture scales.

It can become difficult to know and understand what events are flowing within our domain.

I'm a huge fan of Amazon EventBridge and I wrote this tool to help engineers gain and keep an understanding of events that flow through their domain.

# This solution

<img alt="header" src="./images/architecture-2.png" />

EventBridge atlas uses [parsers](https://eventbridge-atlas.netlify.app/docs/parsers/intro) t

EventBridge atlas uses a combination of open source tools to automatically generate documentation for engineers.

EventBridge Atlas downloads your schemas and parses them into various different outputs (you decide) and ouputs static HTML. So you can host your documentation anywhere!

You can read more on [how it works on the website](https://eventbridge-atlas.netlify.app/docs/how-it-works)

# Getting Started

You should be able to get setup within minutes if you head over to our documentation to get started 👇

➡️ [Get Started](https://eventbridge-atlas.netlify.app/)

# Examples

Here are some screenshots of examples of what EventBridge Atlas can produce using its parsers.

Your AWS Schemas are transformed into the following documentation tools:

## Slate Parser

<img alt="header" src="./images/slate-example.png" />

## AsyncAPI Parser

<img alt="header" src="./images/asyncapi-example.png" />

## Docuowl Parser

<img alt="header" src="./images/docuowl-example.png" />

# Tools

- [Docker](https://www.docker.com/)
- [aws sdk](https://aws.amazon.com/cli/)

### Documentation tools (Parsers)

- [docuowl](https://github.com/docuowl/docuowl)
- [slate](https://github.com/slatedocs/slate)
- [AsyncAPI](https://asyncapi.com)

# Contributing

If you have any questions, features or issues please raise any issue or pull requests you like. I will try my best to get back to you.

[license-badge]: https://img.shields.io/github/license/boyney123/eventbridge-atlas.svg?color=yellow
[license]: https://github.com/boyney123/eventbridge-atlas/blob/main/LICENCE
[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
[prs]: http://makeapullrequest.com
[github-watch-badge]: https://img.shields.io/github/watchers/boyney123/eventbridge-atlas.svg?style=social
[github-watch]: https://github.com/boyney123/eventbridge-atlas/watchers
[github-star-badge]: https://img.shields.io/github/stars/boyney123/eventbridge-atlas.svg?style=social
[github-star]: https://github.com/boyney123/eventbridge-atlas/stargazers

# Sponsor

Coming soon 👀

# License

MIT.