Skip to content

Latest commit

 

History

History
205 lines (149 loc) · 6.24 KB

README.md

File metadata and controls

205 lines (149 loc) · 6.24 KB
Raw

Contributors Forks Stargazers Issues GPL License


Logo

ThunderEye

Service that uses telegram to notify when WarThunder dev server is open
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

![Product Name Screen Shot][product-screenshot]

Here's a blank template to get started: To avoid retyping too much info. Do a search and replace with your text editor for the following: lucas-engen, ThunderEye, twitter_handle, linkedin_username, email_client, email, project_title, project_description

(back to top)

Built With

(back to top)

Getting Started

# Clone repository
git clone https://github.com/lucas-engen/ThunderEye.git
cd ThunderEye

# Install packages
yarn

# Compile project
yarn build

# Run project
yarn test

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • npm and yarn

    npm install npm@latest -g
npm install --global yarn

  • nodejs

    sudo apt install nodejs

Installation

This program doesn't require any installation. You just need to subscribe into telegram channel

Usage

Subscribe into telegram channel https://t.me/wtdevchan and wait for messages

(back to top)

Roadmap

  • [ + ] Implement basic notifications over telegram
    • [ - ] Improve algorithm used to check if dev server is down
  • Notifications over MQTT

See the open issues for a full list of proposed features (and known issues).

(back to top)

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 again!

  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

(back to top)

License

Distributed under the GNU GPL v3 License. See LICENSE for more information.

(back to top)

Contact

Lucas Vieira - gmail

Project Link: https://github.com/lucas-engen/ThunderEye

(back to top)

Acknowledgments

(back to top)