Light

renanbastos93 / alertcovid19 Goto Github PK

View Code? Open in Web Editor NEW

17.0 5.0 3.0 44 KB

Alert COVID-19 is a small multiplatform tool written in Golang to help keep you informed about the current situation of COVID-19 in your region, while you stay safe at home.

License: MIT License

Makefile 12.47% Go 87.53%

covid-19 coronavirus cli go golang-application notify alert golang pandemic windows

alertcovid19's Introduction

DEPPRECATED

URLs were lost so I decided to archive the project.

Alert COVID-19

Alert COVID-19 is a small multiplatform tool written in Golang to help keep you informed about the current situation of COVID-19 in your region, while you stay safe at home.

At every hour, it fetches data from an API and displays a native notification on your system if there's any updates on the number of confirmed cases, deaths or recovered patients.

Getting started

If you just want to get up and running, follow these steps:

Go to the release page
Download the lastest release for your platform (MacOS, Linux or Windows)
Extract the contents and run the executable file

Building the project

If you want to build the project yourself, here's how you can use our Makefile:

# Build the project
$ make <macos|linux|windows>
# If you're on Windows, you can also run "make zip" to create a zipped executable

# Run the program, updating every 10s and if there's a changes, display a notification
# Defaults to 1h00m00s (1 hour)
$ ./alertcovid19 -t 10s

# If you want to remove the built files
$ make clean

# Or simply...
$ go run .

Dependencies for building:

Go
Golint
Gosec

👍 Contributing

If you want to say thank you and/or support the active development of AlertCovid19:

Add a GitHub Star to the project.
Tweet about the project on your Twitter.
Write a review or tutorial on Medium, Dev.to or personal blog.
Help us to translate this README to another language.

Do you wish to contribute?

Open a pull request or issue for we discuss.

Coffee Supporters

Buy Me A Coffee

Code Contributors

_@wgrr	_@u5surf	_@fsmiamoto	_@cyruzin	_{@renanbastos93}

alertcovid19's People

Contributors

Stargazers

Watchers

Forkers

petrosbarreto u5surf fsmiamoto

alertcovid19's Issues

We need to create a context to get an external link

Well, we had a suggestion of @jeffotoni to create a context to control the timeout case external URL doesn't response system.

Doc about the context in Go

Integration with GoReleaser

We can create integration with GoReleaser to generate packages to all platforms.

We must improve documentation

We need to improve documentation to auxiliary everybody to download and contribute to this project. I based on readme from Gofiber.

I am accepting suggestions

Topics:

We need to create a parameter to filter by states

We need to improve this application to create some filters I suggested we create a filter by states but we can create also filter by cities and countries.

Create unit tests with mock method and context

Well, we need to create 2 new tests to validate response data that must be mock. Also, created a test to simulate a loop that gets data.

We should use GeoIP as a parameter default by country.

I've been thinking about how to improve this system to show notification in all countries then I did think we can use GeoIP when starting to consult an API with your IP to get latitude and longitude and get URL in the map and starting consuming referencing API it.

Suggest: https://ip-api.com/

We need to create a feature to start system when the operating system starter

Accepting suggest for this implementation, we wish libs, links, posts, articles about it

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.