ddanielcruz / covid19-api

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

💉 covid19-api

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

💻 Project

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

🚀 Technologies

• TypeScript
• Node.js
• Express
• Cheerio
• MongoDB
• Docker
• Dayjs

🔥 Usage

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

# 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, Yarn and MongoDB. Also, you'll need to fill all .env variables, including commented ones.

# 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

🤔 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

📝 License

This project is licensed under the MIT License - see the LICENSE file for details