Rodizio2o

Open-source application to check the next water restriction in an easier way.

---

⚠️ This project no longer is maintained and is not working due to the normalization of water.

---

About • Idea / Solution • Why no longer works? • Features • Technologies • Getting started

🧐 About

💡 Idea / Solution

The idea behind this project was to make a website to be easily accessed by everyone to see the following restriction on water. The official website provided by the government was buggy and was not mobile-friendly. And it was really difficult to check fast because of the redundancy of inserting the address every time you wanted to see it.

⛓️ Why no longer works?

The reason behing of why this project no longer works is because, after the official release, it was announced on the same day by the government that the restrictions were over by the following week.

🚀 Features

• Consuming Rodizio API to check the next water restriction.
• Prediction system when the API does not provide a date.
• Saving data locally, making faster to use and see the important data.
• PWA for desktop / mobile web applications.

⛏️ Built with

🏁 Getting started

Installing

1. First, clone or download this repository

git clone https://github.com/KeysHD/rodizio2o.git

2. Install all the dependencies

yarn install

3. Run the project

yarn dev

4. Navigate to https://localhost:3000 to view the website
5. Send requests to https://localhost:3001 to get API data

📘 Documentation API

GET restriction water data

  GET /api/rodizio/${cep}/${number}

  GET /api/rodizio?cep=${cep}&num=${number}

Parameter	Type	Description
cep	string	Required. CEP of the place where you want to search
number	string	Required. Number of the place where you want to search

---

  GET /api/rodizio?address=${street}

Parameter	Type	Description
street	string	Required. Address of the place where you want to search

📖 License

MIT License - Copyright (c) 2022 Kevin