An open API service indexing awesome lists of open source software.

https://github.com/pippinmole/helios

An ASP.NET Core web app that monitors the uptime of Helium miners
https://github.com/pippinmole/helios

asp-net-core blockchain bootstrap5 cloud helium hnt iot

Last synced: about 2 months ago
JSON representation

An ASP.NET Core web app that monitors the uptime of Helium miners

Awesome Lists containing this project

README

          

[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]





Logo

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


Logo

This website tracks uptime and diagnoses network issues for [Helium devices](https://www.helium.com/). The backend is written in ASP.NET Core Razor pages (Server-Side Rendering).

(back to top)

### Built With

* [Razor Pages](https://learn.microsoft.com/en-us/aspnet/core/razor-pages/?view=aspnetcore-7.0&tabs=visual-studio)
* [Serilog](https://serilog.net/)
* [reCAPTCHA](https://www.google.com/recaptcha/about/)
* [MongoDB](https://www.mongodb.com/)
* [Bootstrap](https://getbootstrap.com)
* [JQuery](https://jquery.com)

(back to top)

## Getting Started

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

### Installation

1. Clone the repository
```sh
https://github.com/pippinmole/Helios.git
```
2. Restore packages
```sh
dotnet restore
```
3. Set up user secrets
```sh
dotnet user-secrets init
dotnet user-secrets set "ConnectionStrings:DatabaseConnectionString" ""
dotnet user-secrets set "HeliumOptions:TransactionAddress" ""
dotnet user-secrets set "MailSenderOptions:ApiKey" ""
dotnet user-secrets set "MailSenderOptions:Domain" ""
dotnet user-secrets set "MailSenderOptions:FromName" ""
dotnet user-secrets set "RecaptchaSettings:SecretKey" ""
dotnet user-secrets set "RecaptchaSettings:SiteKey" ""
dotnet user-secrets set "Serilog:Datadog:ApiKey" ""
```
4. Build the solution
```sh
dotnet build
```
5. Finally, run
```sh
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: jonathan.ruffles03@gmail.com

Project Link: [https://github.com/pippinmole/Helios](https://github.com/pippinmole/Helios)

(back to top)

[//]: # ()

[//]: # (## Acknowledgments)

[//]: # ()
[//]: # (Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!)

[//]: # ()
[//]: # (* [Choose an Open Source License](https://choosealicense.com))

[//]: # (* [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet))

[//]: # (* [Malven's Flexbox Cheatsheet](https://flexbox.malven.co/))

[//]: # (* [Malven's Grid Cheatsheet](https://grid.malven.co/))

[//]: # (* [Img Shields](https://shields.io))

[//]: # (* [GitHub Pages](https://pages.github.com))

[//]: # (* [Font Awesome](https://fontawesome.com))

[//]: # (* [React Icons](https://react-icons.github.io/react-icons/search))

[//]: # (

(back to top)

)

[stars-shield]: https://img.shields.io/github/stars/pippinmole/Helios.svg?style=for-the-badge
[stars-url]: https://github.com/pippinmole/Helios/stargazers
[issues-shield]: https://img.shields.io/github/issues/pippinmole/Helios.svg?style=for-the-badge
[issues-url]: https://github.com/pippinmole/Helios/issues
[license-shield]: https://img.shields.io/github/license/pippinmole/Helios.svg?style=for-the-badge
[license-url]: https://github.com/pippinmole/Helios/blob/master/LICENSE
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://www.linkedin.com/in/jonathan-ruffles-b44b30196/
[product-screenshot]: images/screenshot.png