https://github.com/thecodrr/covyd
Coronavirus Assistant in your terminal to help you prepare for COVID-19
https://github.com/thecodrr/covyd
assistant assistive-technology bash cli coronavirus coronavirus-info covid-19 covid19 fish health terminal zsh
Last synced: 1 day ago
JSON representation
Coronavirus Assistant in your terminal to help you prepare for COVID-19
- Host: GitHub
- URL: https://github.com/thecodrr/covyd
- Owner: thecodrr
- Created: 2020-03-22T17:32:47.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-07-11T02:42:49.000Z (almost 2 years ago)
- Last Synced: 2025-04-05T18:21:48.842Z (25 days ago)
- Topics: assistant, assistive-technology, bash, cli, coronavirus, coronavirus-info, covid-19, covid19, fish, health, terminal, zsh
- Language: JavaScript
- Homepage:
- Size: 1.7 MB
- Stars: 8
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
Coronavirus Assistant
Spreading awareness about COVID-19 through your terminal
## Features:
**🕺 Automated Reminders:** `covyd` automatically reminds you to take the advised precautions. It merges in with your workflow so you won't even notice it until it pings you.
**🕺 Coronavirus Cases Tracking (WIP):** `covyd` will include a coronavirus case tracker which you can configure to your country. It will occasionally report cases, recoveries etc.
**🌐 100% Offline:** `covyd` is 100% offline. Making it blazing fast.
## Installation:
It is recommended that you install `covyd` globally.
Use `npm`:
```sh
npm install -g covyd
```
Or `yarn`:
```sh
yarn global add covyd
```
After installation simply run:
```sh
covyd init
```
You will be guided through the steps and will be up and running in no time.
> To `uninstall` simply run `covyd uninstall`
## Usage:
_Normally you wouldn't need to manually interact with `covyd` (aside from the first init) but if you wanted to here's the list of command it supports._
### `init`:
Initializes `covyd` and adds necessary configuration to your shell's `.*rc` files;
```sh
$ covyd init
```
### `uninstall`
Uninstalls `covyd` from everywhere.
```sh
$ covyd uninstall
```
### `refresh`
Fetch the latest messages list.
```sh
$ covyd refresh
```
### `stat`
Check how many commands you have executed after installing `covyd`.
```sh
$ covyd stat
```
## Plans:
1. Add support for more shells
2. Add basic support for country based COVID-19 cases tracking. (_Not sure about this_)
3. More messages
4. Desktop notifications? (_Not sure about this_)
## Contributing:
`covyd` cannot grow and help without the contribution from the community. Here are some of the ways you can help out.
### Add more messages:
`covyd` includes [a list of messages](https://github.com/thecodrr/covyd/blob/master/data/messages.txt). Currently it's pretty basic (and short). You can contribute your own tips, stories etc. Simply open a PR with your message and it will be added.
### Add support for your terminal/shell:
**Currently `covyd` supports:**
- `bash`
- `zsh`
- `fish`
Help is requested from the community to add support for other terminal emulators and shells. Anyone with such experience is welcome to contribute. You do not have to contribute code, just leave a short guide on how to implement the functionality and I will handle the rest. PRs are of course welcome
### Fix a bug:
Any and all bug fixes are welcome. You can open a PR or an issue.
### Support by donating:
You can give monetary support [over here](https://ko-fi.com/thecodrr).
## FAQs:
**1. How does it work?**
The concept is very simple. `covyd` has a list of messages. It randomly chooses a message and prints it in the terminal either on startup or after every N commands (configurable).
**2. What are you expecting from this?**
The purpose is simple. To help developers and people maintain a healthy routine and to also give them something fun to work with. `covyd` can grow to become something amazing. And I am hoping the community will see that.
**3. How did it come to be?**
I wanted to be reminded on and off about health tips regarding Coronavirus. Since I am mostly at a terminal all day, the best place for these reminders _is_ the terminal. So this idea came into beign.
**4. Will it have an impact on the performance?**
`covyd` is really lightweight. You shouldn't feel a difference after installing it.
**5. Does it support X shell?**
Please open an issue with the name of your shell and how to configure it to serve the purpose `covyd` aims to serve. It is my mission to support all the terminals out there so all help is welcome.
## LICENSE
```
Copyright (c) 2020 Abdullah Atta under MIT.
```