covid19-api

KO | EN

gitlite — search

#hacktoberfest #react #go #golang #android #rust #deep-learning #java #awesome #cli #vue #pytorch #ios #openai

(★ 11)

:syringe: Coronavirus RESTful API for current cases by country - extracting data from Worldometers

covid19-api Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<div align="center">
  <h1>
    :syringe: <i>covid19-api</i>
  </h1>

<p>
    Coronavirus RESTful API for current cases by country - extracting data from Worldometers
  </p>

## :computer: Project

Simple COVID19 API developed with Node.js and TypeScript. It periodically extracts cases from [Worldometers][source] and store it in a MongoDB database. This project was developed for studying purposes, and contains a [simple documentation](docs/Insomnia.json) in the docs folder.

## :rocket: Technologies

- [TypeScript][typescript]
- [Node.js][nodejs]
- [Express][express]
- [Cheerio][cheerio]
- [MongoDB][mongodb]
- [Docker][docker]
- [Dayjs][dayjs]

## :fire: Usage

To use this project you'll basically have to clone it using [Git][git] and run it using [Docker][docker].

```sh
# Cloning the repository
git clone https://github.com/danielccunha/covid19-api.git
cd covid19-api

# Setting up environment variables (MongoDB credentials basically)
cp .env.example .env
nano .env

# Running it with Docker on http://localhost:3333
docker-compose up -d
```

In case you don't want to use Docker, you'll need to also have installed on your machine [Node.js][nodejs], [Yarn][yarn] and [MongoDB][mongodb]. Also, you'll need to fill all `.env` variables, including commented ones.

```sh
# Cloning the repository
git clone https://github.com/danielccunha/covid19-api.git
cd covid19-api

# Setting up environment variables (you'll need to fill all MongoDB variables)
cp .env.example .env
nano .env

# Installing dependencies
yarn

# Running worker which will extract cases hourly
yarn dev:worker

# Finally, running the serve on port 3000
yarn dev:server
```

## :thinking: Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.

1. Fork the project
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
3. Commit your changes (`git commit -m 'feat: Add some AmazingFeature'`)
4. Push to the branch (`git push origin feature/AmazingFeature`)
5. Open a pull request

## :memo: License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details

[source]: https://www.worldometers.info/coronavirus/
[git]: https://git-scm.com/
[docker]: https://www.docker.com/
[nodejs]: https://nodejs.org/
[mongodb]: https://www.mongodb.com/
[yarn]: https://yarnpkg.com/
[express]: http://expressjs.com/
[cheerio]: https://cheerio.js.org/
[typescript]: https://www.typescriptlang.org/
[dayjs]: https://github.com/iamkun/dayjs

covid19-api

covid19-api Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

covid19-api

covid19-api Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README