Git Product home page Git Product logo

eventbridge-atlas's Introduction

AWS EventBridge Atlas ๐Ÿ—บ

Document, Discover and Share AWS EventBridge Schemas.

MIT License PRs Welcome

Watch on GitHub Star on GitHub


header

Features: Parses schemas into documentation, shows rules matched to your events, add metadata to each event property, fuzzy search, show example events, light & dark more, and more...

Read the Docs | Edit the Docs


The problem

Event-Driven Architectures allow us to scale, be agile and keen 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 AWS EventBridge and I wrote this tool to help engineers gain and keep an understanding of events that flow through their domain.

This solution

header

This tool uses a combination of open source tools to automatically generate documentation for engineers.

EventBridge Atlas will output static HTML, so you can host your documentation anywhere!

Getting Started

EventBridge Atlas has its own documentation website. To get started head over there.

โžก๏ธ Documentation

Tools

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.

Donating

If you find this tool useful, feel free to buy me a โ˜• ๐Ÿ‘

Buy a drink

License

MIT.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.