Home

1. Introduction
2. Goals
3. Hardware used
4. Tech Stack
5. Contribution Guidelines
6. Open Source Programs
7. Frequently Asked Questions(FAQs) for GSSoC'20
8. Additional Info
9. Team
10. Useful Resources

Introduction

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. The water tanks can be fixed with ultrasonic sensors that are placed over the container. The ultrasonic sensor is used to measure, compare container depth and liquid level.

The status of the system could be monitored by an LCD screen or a web page that provides a brilliant graphical representation. Colors 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

The primary goal of this project is to make efficient use of water across the city. This project will help us to make use of technology for conserving natural resources. We can use this system to keep track of the water consumption and depletion over some time, and thus analyze its usage.

Hardware Used

• AVR family microcontroller
• LCD screen
• Wifi modem
• A buzzer
• 12V transformer

Tech Stack

• HTML
• CSS
• JavaScript
• JQuery
• Arduino

How to get started

1. Fork this repository.

2. Clone the forked repository.
   git clone https://github.com/<your-github-username>/Water-Monitoring-System

3. Navigate to the project directory.
   cd Water-Monitoring-System

4. Create a new branch.
   git checkout -b <your_branch_name>

5. Make changes in source code.

6. Commit your changes.

   git add .
git commit -m "<your_commit_message>"

7. Push your local branch to the remote repository.
   git push -u origin <your_branch_name>

8. Create a PR!

Congratulations! Sit and relax, you've made your contribution to Water Monitoring System project.

Contribution Guidelines

• Write clear meaningful git commit messages (Do read this).

• 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 for more info)

• When you make very very minor changes to a PR of yours (like for example fixing a text in the 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)

• 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 to create the PR.

• Always create PR to develop branch.

• Please read our Code of Conduct.

• Refer this for more.

Open Source Programs

This project is part of the following Open Source programs:

• GirlScript Summer of Code 2020
• Rails Girls Summer of Code 2020
• JGEC Winter of Code 2020

Frequently Asked Questions(FAQs) for GSSoC'20

This project is accepting contributions under GirlScript Summer of Code 2020 - three months long Open Source program conducted by GirlScript Foundation.

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 integrated with the real-time data from the sensors.

3. How to communicate with us?

All communication will happen on the Slack channel for this project. Mentors can also be reached through GitHub. Avoid DMs and unnecessary mentions on slack and GitHub both. Checkout this 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.

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 labeled with first-timers-only. These issues might let your Open Source journey begin - Welcome onboard!

Team

Mentors

GitHub Usernames	Domain
@vinitshahdeo	Full Stack + Documentation
@ShreyaAnand	Full Stack
@YashMeh	Backend
@PragatiVerma18	Backend + Documentation
@ramanaditya	Backend + Hardware
@ArpitKotecha	Backend
@Manvityagi	APIs + Cloud
@jainpawan21	Frontend

Project Admin

Vinit Shahdeo

Useful Resources

• Django Docs
• React Docs
• Node.js Docs
• Git and GitHub

---

/**
 *
 * {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
}

---