README em português

An API with COVID-19 data from Curitiba.
Explore the docs »

View instructions · Report Bug · Request Feature . Example usage

Table of Contents

1. About The Project
   • Built With
2. Getting Started
3. Contributing
4. License
5. Contact

About The Project

There are many COVID-19 APIs, however, none of them hand detailed data, in a open-source way, from my city (Curitiba A.K.A cwb).

Why?

• Curitiba citizens must know how this disease is being handled over time.

• The time for creating apps or websites about this subject can be highly demanding. This project can save a lot of that work.

Needless to say, this API is very focused on my local region. So you may also suggest changes by forking this repo and creating a pull request or opening an issue.

Built With

Server

• Express
• Postgres
• Typescript

Scraper

• Python
• Selenium

Website with instructions

• React
• Typescript
• Styled components

Getting Started

There are three folders: a scraper (data gathering), a server (data display) and a instructions-website (website telling how to use the API)

Each folder has a README explaining how to install and run in your computer.

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 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

• Discord: Losaeg#1619
• Email: marcelorissette15@gmail.com

Project Link: https://github.com/marcelo-schreiber/CWB-COVID-API

Made with <3 by Marcelo Schreiber