Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vinitshahdeo/Water-Monitoring-System
Water Monitoring System is an IOT based Liquid Level Monitoring system that has mechanisms to keep the user alerted in case of liquid overflow or when tank depletes.
https://github.com/vinitshahdeo/Water-Monitoring-System
api arduino coronavirus coronavirus-real-time coronavirus-tracking covid-19 django gssoc gssoc20 hacktoberfest hacktoberfest2020 hardware iot javascript jquery nodejs rgsoc ultrasonic-sensors water-monitoring
Last synced: about 1 month ago
JSON representation
Water Monitoring System is an IOT based Liquid Level Monitoring system that has mechanisms to keep the user alerted in case of liquid overflow or when tank depletes.
- Host: GitHub
- URL: https://github.com/vinitshahdeo/Water-Monitoring-System
- Owner: vinitshahdeo
- License: mit
- Created: 2018-07-19T22:06:05.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-02-18T16:38:49.000Z (11 months ago)
- Last Synced: 2024-08-03T17:08:10.139Z (5 months ago)
- Topics: api, arduino, coronavirus, coronavirus-real-time, coronavirus-tracking, covid-19, django, gssoc, gssoc20, hacktoberfest, hacktoberfest2020, hardware, iot, javascript, jquery, nodejs, rgsoc, ultrasonic-sensors, water-monitoring
- Language: HTML
- Homepage: https://vinitshahdeo.github.io/Water-Monitoring-System/
- Size: 30.5 MB
- Stars: 148
- Watchers: 12
- Forks: 264
- Open Issues: 111
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# [Water Monitoring System](https://vinitshahdeo.github.io/Water-Monitoring-System/) - IoT Project
---
> ## :mask: [COVID-19](http://corona-cases-india.netlify.com/) | Stay Home, Stay Safe! :house:
:mag_right: Checkout [this](http://corona-cases-india.netlify.com/) web app for live CORONA updates.
> ### :incoming_envelope: Read my open letter [here](https://github.com/vinitshahdeo/Water-Monitoring-System/issues/236). :heart:
> ## :bar_chart: Checkout the [COVID-19 Tracker :mask: | INDIA](https://indiafightscorona.netlify.app/) :india:
> ### :point_right: You can find the repo [here](https://github.com/vinitshahdeo/COVID19/). :star:
---
[](https://github.com/vinitshahdeo/Water-Monitoring-System/issues?q=is%3Aissue+is%3Aopen+label%3Afirst-timers-only) [](https://github.com/vinitshahdeo/Water-Monitoring-System/blob/master/LICENSE) [](https://github.com/vinitshahdeo/Water-Monitoring-System/stargazers) [](https://github.com/vinitshahdeo/Water-Monitoring-System/network/members) [](https://github.com/vinitshahdeo/Water-Monitoring-System) [](https://www.codetriage.com/vinitshahdeo/water-monitoring-system)
> **You can view the demo [here](https://vinitshahdeo.github.io/Water-Monitoring-System/src/home.html).**
[](https://github.com/vinitshahdeo/Water-Monitoring-System/) [](https://github.com/vinitshahdeo/Water-Monitoring-System/)
Water Monitoring System is an IoT based Liquid Level Monitoring system that has the mechanism to keep the user alerted in case of liquid overflow or when tank depletes. The water tanks can be fixed with ultrasonic sensors that is placed over the container. Ultrasonic sensor is used to measure, compare container depth and liquid level.
The status of the system could be monitored by a LCD screen or a web page that provides a brilliant graphical representation. Colours are used to depict various scenarios with respect to the amount of liquid in the tanks or containers and the buzzer buzzes when the limit exceeds the permissible quantity of fill.
### Goals of this project :
- **_To reduce the wastage of water across the city_**
- **_To provide better water supply to the people_**
```js
____ __ __ _
/ ___| __ ___ _____ \ \ / /_ _| |_ ___ _ __
\___ \ / _` \ \ / / _ \ \ \ /\ / / _` | __/ _ \ '__|
___) | (_| |\ V / __/ \ V V / (_| | || __/ |
|____/ \__,_| \_/ \___| \_/\_/ \__,_|\__\___|_|
____ _ _ __
/ ___| __ ___ _____ | | (_)/ _| ___
\___ \ / _` \ \ / / _ \ | | | | |_ / _ \
___) | (_| |\ V / __/ | |___| | _| __/
|____/ \__,_| \_/ \___| |_____|_|_| \___|
```
> **Click [here](https://github.com/vinitshahdeo/Water-Monitoring-System/blob/master/docs/Water%20level%20monitoring%20system.pdf?raw=true) to download the report.**
The IoT(Hardware) components required are:
- **AVR family microcontroller**
- **LCD screen**
- **Wifi modem**
- **A buzzer**
- **12V transformer**
## Getting Started
[](https://vinitshahdeo.github.io/Water-Monitoring-System/) [](https://github.com/vinitshahdeo/Water-Monitoring-System/commits/) [](https://vinitshahdeo.github.io/Water-Monitoring-System/)
**1.** Fork [this](https://github.com/vinitshahdeo/Water-Monitoring-System/) repository.
Click on the 
symbol at the top right corner.
**2.** Clone the forked repository.
```bash
git clone https://github.com//Water-Monitoring-System
```
**3.** Navigate to the project directory.
```bash
cd Water-Monitoring-System
```
**4.** Create a new branch.
```bash
git checkout -b
```
**5.** Make changes in source code.
**6.** Stage your changes and commit
```bash
#Add changes to Index
git add .
#Commit to the local repo
git commit -m ""
```
>CAUTION: Synch up your local repo with [original repo](https://github.com/vinitshahdeo/Water-Monitoring-System) (Upstream) before pushing your commits.
>This avoids unnecessary conflicts during the merge.
>NOTE: You can do so by adding a [remote handler](https://www.atlassian.com/de/git/tutorials/syncing) reference to the original repo and pull the changes from the respective branch.
>Resolve the [merge-conflicts](https://www.atlassian.com/de/git/tutorials/using-branches/merge-conflicts) if any.
>TIPS: [Workflow diagram](git-workflow.svg)
>```bash
>#Add upstream repo
>git remote add upstream https://github.com/vinitshahdeo/Water-Monitoring-System.git
>
>#Disable accidental push to the upstream
>git remote set-url --push upstream DISABLE
>
>#List the remote repo and fetch references
>git remote -v && git fetch upstream
>
>#Check for any new commits in the upstream branch
>git log HEAD..upstream/master #No output indicates, upstream has not moved ahead
>
>#See the patch difference between local and upstream branch
>git diff -p HEAD..upstream/master
>
>```
>CAUTION: If the upstream has moved ahead, rebase your commit and resolve conflicts if any. [Skip otherwise]
>```bash
>git rebase upstream/master
>```
>
**7.** Push your local commits to the remote repo.
```bash
git push -u origin
```
**8.** Create a [PR](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request) !
**9.** **Congratulations!** Sit and relax, you've made your contribution to [Water Monitoring System](https://vinitshahdeo.github.io/Water-Monitoring-System/) project.
## Issues
[](https://github.com/vinitshahdeo/Water-Monitoring-System/issues) [](https://github.com/vinitshahdeo/Water-Monitoring-System/pulls) [](https://github.com/vinitshahdeo)
| TITLE | LEVEL |
| -------------------------------------------------------------------------------------------------------------- | ----------- |
| [UI Enhancements](https://github.com/vinitshahdeo/Water-Monitoring-System/issues/2) | `EASY` |
| [Project Documentation](https://github.com/vinitshahdeo/Water-Monitoring-System/issues/3) | `VERY EASY` |
| [Setting up Cloud APIs to send/receive data](https://github.com/vinitshahdeo/Water-Monitoring-System/issues/4) | `MEDIUM` |
| [Admin Dashboard ](https://github.com/vinitshahdeo/Water-Monitoring-System/issues/5) | `HARD` |
| [Notify stakeholders](https://github.com/vinitshahdeo/Water-Monitoring-System/issues/6) | `ADVANCED` |
**NOTE**: **Feel free to [open issues](https://github.com/vinitshahdeo/Water-Monitoring-System/issues/new/choose)**. Make sure you follow the Issue Template provided.
## Contribution Guidelines
[](https://github.com/vinitshahdeo/Water-Monitoring-System/compare) [](https://github.com/vinitshahdeo/Water-Monitoring-System/graphs/contributors) [](https://github.com/vinitshahdeo/)
- Write clear meaningful git commit messages (Do read [this](http://chris.beams.io/posts/git-commit/)).
- Make sure your PR's description contains GitHub's special keyword references that automatically close the related issue when the PR is merged. (Check [this](https://github.com/blog/1506-closing-issues-via-pull-requests) for more info)
- When you make very very minor changes to a PR of yours (like for example fixing a text in button, minor changes requested by reviewers) make sure you squash your commits afterward so that you don't have an absurd number of commits for a very small fix. (Learn how to squash at [here](https://davidwalsh.name/squash-commits-git))
- When you're submitting a PR for a UI-related issue, it would be really awesome if you add a screenshot of your change or a link to a deployment where it can be tested out along with your PR. It makes it very easy for the reviewers and you'll also get reviews quicker.
- Please follow the [PR Template](https://github.com/vinitshahdeo/Water-Monitoring-System/blob/master/.github/PULL_REQUEST_TEMPLATE.md) to create the PR.
- Always create PR to `develop` branch.
- Please read our [Code of Conduct](./CODE_OF_CONDUCT.md).
- Refer [this](https://github.com/vinitshahdeo/Water-Monitoring-System/blob/master/CONTRIBUTING.md) for more.
## Open Source Programs
This project is part of the following Open Source programs:
- [GirlScript Summer of Code 2020](https://www.gssoc.tech/)
- [Rails Girls Summer of Code 2020](http://railsgirlssummerofcode.org/)
- [Student Code In](https://scodein.tech/)
- [Leapcode](https://www.leapcode.io/)
- [JGEC Winter of Code 2020](https://jwoc.tech/)
- [Hacktoberfest 2020](https://hacktoberfest.digitalocean.com/)
- [Script Winter Of Code](https://swoc.tech/)
## Frequently Asked Questions(FAQs) for [GSSoC'20](https://www.gssoc.tech/)
> This project is accepting contributions under [GirlScript Summer of Code 2020](https://www.gssoc.tech/) - three months long Open Source program conducted by [GirlScript Foundation](https://www.gssoc.tech/).
[](https://www.gssoc.tech/)
#### _1. How to start as a beginner so as to contribute to the project?_
_There are many beginner level issues to begin with, which include documentation, development and design. Also, feel free to make issues for features as well as for reporting bugs.Participants can claim an issue by commenting that they are interested in it. We are also open to new ideas and suggestions._
#### _2. Is this a hardware/IoT project?_
_Yes, it is a hardware/IoT + software project. There would be maximum tasks related to frontend, backend, design and documentation of the website and later, it would be integarted with the real-time data from the sensors._
#### _3. How to communicate with us?_
_All communication will happen on the Slack channel for this particular projects. Mentors can also be reached through GitHub. Avoid DMs and unnecessary mentions on slack and GitHub both. Checkout [this](https://github.com/vinitshahdeo/Water-Monitoring-System/issues/15) issue for more._
#### _4. What is the Tech Stack for this project?_
- **Frontend:** React
- **Backend:** Django, Node.js
#### _5. What is the deadline for any task submission?_
_Mentors can assign issues to participants and also mention a deadline before which the issue is to be resolved. They can reassign issues in case of any delay, so be active and complete your tasks within the negotiated duration._
## Shared experiences on [GSSoC'20](https://www.gssoc.tech/) :pencil:
| Article | Author |
|-------------------------------------------------------|---------------------------------------------------|
| [GirlScript Summer of Code 2020 Mentor Experience](https://medium.com/girlscript-summer-of-code/girlscript-summer-of-code-2020-mentor-experience-28daec399b1e) | [@PragatiVerma18](https://github.com/PragatiVerma18)|
| [GSSOC 2020-A journey to explore the “UNEXPLORED”](https://medium.com/@swara.shukla65/gssoc-2020-a-journey-to-explore-the-unexplored-f25a6ade8288) | [@Swarnimashukla](https://github.com/Swarnimashukla) |
## About [RGSoC'20](https://railsgirlssummerofcode.org/)
```javascript
var baseURL = `https://github.com`,
projectsInRGSoC = _.filter(appliedProjects,
(project) => {
RGSoC.isSelected(project,
new Date().getFullYear())
});
if (_.contains(projectsInRGSoC, {
name: `Water Monitoring System`,
url: `${baseURL}Water-Monitoring-System`
})) {
fork('Water Monitoring System');
// Looking forward to awesome contributions
console.log('Thank You RGSoC');
}
```
**Glad to share that this project is shortlisted for [Rails Girls Summer Of Code 2020](https://railsgirlssummerofcode.org/)**, a global fellowship program for women and non-binary coders. Students receive a three-month scholarship to work on existing Open Source projects and expand their skill set.
- [Click here](https://railsgirlssummerofcode.org/blog/) to learn more.
- **RGSoC student applications have officially started on Monday, 02 March 2020. Apply [here](https://teams.railsgirlssummerofcode.org/apply).**
- Check out the project [here](https://teams.railsgirlssummerofcode.org/projects/293-water-monitoring-system).
- **[Click here](https://twitter.com/Vinit_Shahdeo/status/1234936360613695489) to view the tweet**. RTs are most welcome! :heart:
- Feel free to **shoot your doubts [here](https://github.com/vinitshahdeo/Water-Monitoring-System/issues/141)**.
## Leapcode
[](http://leapcode.io/)
Now, we're officially a part of [leapcode.io](http://leapcode.io/). They're still building and hopeful to have their platform up pretty soon. [Click here](https://www.leapcode.io/) to get an early access.
## Hacktoberfest
**Register [here](https://hacktoberfest.digitalocean.com) for Hacktoberfest and make four pull requests (PRs) between October 1-31 to earn a free t-shirt.**
There are many beginner level issues to begin with, with **Hacktoberfest** as the label which include documentation, development and design. Take up any issue and send your first PR!
## Additional Info
- If you're interested in contributing for **documentation**, please checkout `feature/documentation` branch.
- If you're interested in contributing for **backend**, please checkout the following branch according to the tech stack:
- **Django**: `feature/backend-django`
- **Node.js**: `feature/backend-node`
- If you're interested in contributing for **frontend**, please checkout `feature/frontend` branch.
> **Note:** Are you an **absolute beginner?** Please [check the issues](https://github.com/vinitshahdeo/Water-Monitoring-System/issues?q=is%3Aopen+is%3Aissue+label%3Afirst-timers-only) labeled with `first-timers-only`. These issues might _let your Open Source journey begin_ - **Welcome onboard!**
## Mentors
[](https://github.com/vinitshahdeo) [](https://github.com/vinitshahdeo/Water-Monitoring-System/pulls?q=is%3Apr+is%3Aclosed)
| GitHub Usernames | Domain |
| ----------------------------------------------------- | -------------------------- |
| [@vinitshahdeo](https://github.com/vinitshahdeo) | Full Stack + Documentation |
| [@ShreyaAnand](https://github.com/ShreyaAnand) | Full Stack |
| [@YashMeh](https://github.com/YashMeh) | Backend |
| [@PragatiVerma18](https://github.com/PragatiVerma18) | Backend + Documentation |
| [@ramanaditya](https://github.com/ramanaditya) | Backend + Hardware |
| [@ArpitKotecha](https://github.com/ArpitKotecha) | Backend |
| [@Manvityagi](https://github.com/Manvityagi) | APIs + Cloud |
| [@divyabhushan](https://github.com/divyabhushan) | Documentation |
| [@jainpawan21](https://github.com/jainpawan21) | Frontend |
| [@amaaniqbal](https://github.com/amaaniqbal) | Frontend |
| [@nainikaB](https://github.com/nainikaB) | UI/UX |
| [@roypratik](https://github.com/roypratik) | IoT |
| [@sharmishthadash](https://github.com/sharmishthadash)| Product Management |
| [@nandikajain](https://github.com/nandikajain) | Frontend (React) |
| [@harshita19244](https://github.com/harshita19244) | Frontend (React) |
[](https://sourcerer.io/fame/vinitshahdeo/vinitshahdeo/Water-Monitoring-System/links/0)[](https://sourcerer.io/fame/vinitshahdeo/vinitshahdeo/Water-Monitoring-System/links/1)[](https://sourcerer.io/fame/vinitshahdeo/vinitshahdeo/Water-Monitoring-System/links/2)[](https://sourcerer.io/fame/vinitshahdeo/vinitshahdeo/Water-Monitoring-System/links/3)[](https://sourcerer.io/fame/vinitshahdeo/vinitshahdeo/Water-Monitoring-System/links/4)[](https://sourcerer.io/fame/vinitshahdeo/vinitshahdeo/Water-Monitoring-System/links/5)[](https://sourcerer.io/fame/vinitshahdeo/vinitshahdeo/Water-Monitoring-System/links/6)[]()
## Useful Resources
- [Django Docs](https://docs.djangoproject.com/en/3.0/)
- [React Docs](https://reactjs.org/docs/getting-started.html)
- [Node.js Docs](https://nodejs.org/api/)
- [Git and GitHub](https://www.digitalocean.com/community/tutorials/how-to-use-git-a-reference-guide)
## Project Admin
[](https://github.com/vinitshahdeo/) [](https://github.com/vinitshahdeo/)
| 
|
| :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| **[Vinit Shahdeo](https://www.linkedin.com/in/vinitshahdeo/)** |
| 
|
> **_Need help?_**
> **_Feel free to contact me @ [[email protected]](mailto:[email protected]?Subject=WaterMonitoringProject)_**
[](https://github.com/vinitshahdeo/) [](https://twitter.com/Vinit_Shahdeo)
## COVID-19Stay Home, Stay Safe!
I hope you are all staying safe at your home and enjoying the contribution for your awesome open source projects.
```javascript
/**
*
* Let's fight for Corona together!
*/
function stayAtHome() {
eat();
sleep();
code();
repeat();
}
while(_.isAlive(new Virus('COVID-19'))) {
// Stay home, Stay safe
stayAtHome();
}
```
### :wave: [DO THE FIVE](https://www.mohfw.gov.in/): Help stop coronavirus
1. **HANDS**: Wash them often
2. **ELBOW**: Cough into it
3. **FACE**: Don't touch it
4. **SPACE**: Keep safe distance
5. **HOME**: Stay if you can
### :x: Avoid Handshakes :handshake:
### :heavy_check_mark: Do Namastey :pray:
**PS: I know it's off-topic but **Yes**, COVID-19 everyone's talking about. Please stay safe at your home and enjoy contributing to your projects.**
_Your friend,_
_**[Vinit](https://www.instagram.com/vinitshahdeo/) :)**_
---
```javascript
/**
*
* {thisRepo.url} = https://github.com/vinitshahdeo/Water-Monitoring-System/
*
*/
if (thisRepo.isAwesome()) {
thisRepo.fork(); // waiting for your awesome contributions :)
thisRepo.star(); // thanks in advance :p
thisRepo.watch(bug => {
if (!doesIssueExists(bug)) {
createNewIssue(bug); // wow, that's a nice catch
} else {
checkIssueTracker(bug); // comment there
}
});
thisRepo.share(); // sharing is caring :D
}
```
---
[](https://github.com/vinitshahdeo/) [](https://github.com/vinitshahdeo/) [](https://github.com/vinitshahdeo/)
:hugs:
Check out my other projects here!