Skip to content

Latest commit

 

History

History
51 lines (36 loc) · 1.67 KB

README.md

File metadata and controls

51 lines (36 loc) · 1.67 KB
Raw

Watchdog 🐕

Overview

Watchdog is an open-source project that leverages the power of Go and Kafka to build a robust and scalable alert system.

Demo

demo video

Getting Started

  1. Clone the repository

    git clone https://github.com/NickNaskida/Watchdog.git

  2. Install docker (if you don't have it already)

  3. Run the following command to start the project

    docker-compose up --build

  4. Open your browser and navigate to http://localhost:3000

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks in advance!

In general, we follow the "fork-and-pull" Git workflow

How to submit a Pull Request

  • Search our repository for open or closed Pull Requests that relate to your submission. You don't want to duplicate effort.
  • Fork the project on GitHub.
  • Create your feature branch
  • Do your work. Read the docs to this project.
  • Commit your changes (Please use semantic commit messages: Semantic commit messages)
  • Push to the branch
  • Open a Pull Request and wait for feedback.

🎉 Thank you for your contribution!

License

This project is licensed under the MIT License - see the LICENSE file for details.