README.md

Helios Monitor

Monitor your Helium miners' uptime and get notified when they go down!
Explore the docs »

View Demo · Report Bug · Request Feature

About The Project

This website tracks uptime and diagnoses network issues for Helium devices. The backend is written in ASP.NET Core Razor pages (Server-Side Rendering).

(back to top)

Built With

• Razor Pages
• Serilog
• reCAPTCHA
• MongoDB
• Bootstrap
• JQuery

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Installation

1. Clone the repository

   https://github.com/pippinmole/Helios.git

2. Restore packages

   dotnet restore

   3. Set up user secrets

    dotnet user-secrets init
    dotnet user-secrets set "ConnectionStrings:DatabaseConnectionString" "<Get this from your dashboard>"
    dotnet user-secrets set "HeliumOptions:TransactionAddress" "<Helium Address>"
    dotnet user-secrets set "MailSenderOptions:ApiKey" "<Get this from your MailGun dashboard>"
    dotnet user-secrets set "MailSenderOptions:Domain" "<The domain emails will come from>"
    dotnet user-secrets set "MailSenderOptions:FromName" "<The name emails will come from>"
    dotnet user-secrets set "RecaptchaSettings:SecretKey" "<Get this from your google dashboard>"
    dotnet user-secrets set "RecaptchaSettings:SiteKey" "<Get this from your google dashboard>"
    dotnet user-secrets set "Serilog:Datadog:ApiKey" "<Get this from Datadog dashboard>"

3. Build the solution

   dotnet build

4. Finally, run

   dotnet run

(back to top)

Usage

Once you have executed dotnet run , a website at https://localhost:7086/ will be available. This site allows you to:

1. Create an account and sign in
2. Add Helium miners to your 'watch list'
3. Upgrade your account type by paying HNT to a specified address
4. Run diagnostics on your Helium device (Port checking, etc.)

(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 MIT License. See LICENSE for more information.

(back to top)

Contact

E-mail: [email protected]

Project Link: https://github.com/pippinmole/Helios

(back to top)