govent

README

Go-Vent

Table of Contents

• About the Project
  • Built With
  • Dependencies
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

Go-Vent is a synchronous event distribution system between different microservices.

Configurable through database and customizable through plugins.

Built With

We use Golang as the base language and docker images are provided for deployment.

Use go mod as dependencies manager.

Dependencies

TBD

Getting Started

#Installation by source
go get github.com/jarlex/govent
cd $GO_PATH/github.com/jarlex/govent
./build.sh

#Download image
docker pull #TBD

Prerequisites

• Golang 1.12.5

Installation

TBD

Usage

TBD

Roadmap

TBD

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

TBD

Acknowledgements

TBD

Documentation

Index

• type Protocol
• type Trigger

Types

type Protocol

type Protocol int

const (
	GRPC Protocol = iota
	JSON
	TEXT
)

type Trigger

type Trigger struct {
	Matcher map[string]string
	Actions []actions.GenericAction
}