covid19-stats-nepal

KO | EN

gitlite — search

#react #typescript #golang #machine-learning #rust #deep-learning #linux #docker #macos #windows #cli #vue #security #open-source

covid19-stats-nepal

(★ 10)

Twitter bot that tweets the covid19 stats of Nepal.

covid19-stats-nepal Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Covid19 Stats Nepal

<div align="center">
<img width="200" src="docs/logo.jpg" alt="अधिसुचक" style="border-radius:100%">
<p><a href="https://twitter.com/stats_nepal" target="_blank" rel="noopener">Bot</a> that tweets the Covid19 Stats Of Nepal.
</div>

[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

## Tweet

![Tweet](https://raw.githubusercontent.com/sndsabin/covid19-stats-nepal/master/docs/tweet.png)
![Tweet](https://raw.githubusercontent.com/sndsabin/covid19-stats-nepal/master/docs/tweet-ii.png)

## Prerequisites

- [Node.js](https://yarnpkg.com/en/docs/install)
- [Yarn](https://yarnpkg.com/en/docs/install)
- [NPM](https://docs.npmjs.com/getting-started/installing-node)
- [PostgreSQL](https://www.postgresql.org/download/) / [MySQL](https://www.mysql.com/downloads/) / [SQLite](https://www.sqlite.org/download.html)

## Installation

1. create `env`

```bash
   cp .env.example .env
   ```

update the application and database credentials.

`.env` for simple sqlite database setup

```
   DB_CLIENT=sqlite
   DB_DATABASE=./storage/covid19-stats-nepal.sqlite
   ```

- If you wish to cron to run **every minute inorder** to fetch the data and the listed attributes (`recovered`, `pcr_positive`, `pcr_sample_tested`) to be observed for change. add these below env variables to `.env`

```
   STAT_CRON_EXPRESSION=* * * * *
   DATA_TO_BE_OBSERVED=recovered,pcr_positive,pcr_sample_tested
   ```

2. Run migration

```bash
    yarn run knex migrate:latest
   ```

if you wish to seed

```bash
    yarn run knex seed:run
   ```

3. Add [Twitter Secrets]('https://developer.twitter.com/') to `.env`
   ```
   TWITTER_CONSUMER_KEY=
   TWITTER_CONSUMER_SECRET=
   TWITTER_ACCESS_TOKEN=
   TWITTER_ACCESS_TOKEN_SECRET=
   ```
4. Start the application

```bash
   yarn dev (for development)
   NODE_ENV=production yarn start (for production)
   ```

### To run the worker manually

```bash
yarn worker
```

### for `knex` commands

```bash
yarn knex --help
```

## Uses:

- ES7 [async](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function)/[await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
- [Bookshelf](http://bookshelfjs.org/) ORM and [Knex](http://knexjs.org/) migrations
- SQLite (default) with support for MySQL and PostgreSQL
- [dotenv](https://www.npmjs.com/package/dotenv) for configuration management
- [winston](https://www.npmjs.com/package/winston) for logging
- [jest](https://www.npmjs.com/package/jest), [supertest](https://www.npmjs.com/package/supertest) for testing
- [Standard JS](https://standardjs.com/) for code linting

## Credits

Template : [Bootstrap Pricing](https://getbootstrap.com/docs/4.5/examples/pricing), Timeline: [Brady Wright](https://codepen.io/brady_wright/pen/NNOvrW)

## License

[GNU General Public License v3.0](LICENSE)

covid19-stats-nepal

covid19-stats-nepal Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

covid19-stats-nepal

covid19-stats-nepal Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README