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://vinitshahdeo.github.io/Water-Monitoring-System/
MIT License
148 stars 265 forks source link

Welcome to GSSoC 2020 #15

Open vinitshahdeo opened 4 years ago

vinitshahdeo commented 4 years ago

Hello,

Thanks for showing your interest in GSSoC 2020. Super glad to know that you're interested in contributing to Water Monitoring System project.

powered by water

Feel free to ask your doubts here. Kindly note that the coding period starts from 1st March. I recommend you to go through the open issues and have an idea prior to the event. There will be more first-timers issues opened by us soon.

Regards, Vinit ShahdeoProject Admin

Open Source Love

Swarnimashukla commented 4 years ago

Hi vinit , I am a gssoc participant and interested in creating documentation for this project . I have few doubts regarding the same .

  1. Do I need to use exact same template as given in sample report 1? 2.Where can I find images related to project ? 3.I need to work on all the parts of documentation or is there anything already completed ?
vinitshahdeo commented 4 years ago

@Swarnimashukla

1. Feel free to use your own template if you have a better one. Before submitting the PR, please discuss on #3

2. As of now, please create a high-level architectural diagram using Whimsical.

3. Nope - only the basic idea is documented. Find it here.

ShauryaBhandari commented 4 years ago

Hi! I would like to work upon the admin dashboard and design and code the front-end for the same. But I would need a back-end guy to link all the pages and work on the authentication so that only the admin can access it. Please let me know if anybody would like to work upon the same with me. Thank you.

vinitshahdeo commented 4 years ago

@ShauryaBhandari The UI for Admin Dashboard - #5 will have multiple UI sub-tasks as per wireframe. Stay tuned!

himanshusharma89 commented 4 years ago

Hello @vinitshahdeo , I would like to create a web app of the monitoring system using Flutter. Is t possible to do that?

vinitshahdeo commented 4 years ago

@himanshusharma89 Yeah - that's a good idea. Will definitely look into this.

vinitshahdeo commented 4 years ago

Hello everyone!

Join me to welcome the mentors -

Feel free to reach out to me( @vinitshahdeo ) or mentors for any kind of help.

animeshsrivastava24 commented 4 years ago

Hello @vinitshahdeo I'm a GSSOC participant. I'm happy to be a part of this community. I've few queries:

  1. Can we create a real time working model using AutoDesk simulators/Labview for live visualisation of the project and sharing?
  2. I'll like to take up the documentation process, should we contribute directly to a wiki for the same or an io page for the project?
  3. What will be the ideal time to open issues and submit PRs for the project? Eager to hear from you.
saks1209am commented 4 years ago

Hello @vinitshahdeo

Can we create the water monitoring system using machine learning and R. I have a dataset along with me through which we can predict the outcome using the F1 score and then deploy the model using Flutter. I can work on think speak server as I know how to send the data to the cloud and display the data using sensors.I can help in the documentation part also as I have a template with me and will be ready to write a blog on it if u agree.

vinitshahdeo commented 4 years ago

@saks1209am, Can you elaborate on what kind of prediction you'll be making and how will it gonna help to achieve the goals of this Project?

vinitshahdeo commented 4 years ago

@animeshsrivastava24 Here you go:

  1. Yes, we can - Once we reach some level of maturity from the development side, we'll work on the visualization

  2. Documentation consists of a detailed report (.pdf) and a wiki page - soon we'll have one wiki page.

  3. We'll be accepting contributions from 1st of March.

Thanks for showing your interest.

saks1209am commented 4 years ago

@vinitshahdeo This is a water level monitoring system but we can integrate it with water anomaly detection to predict that water is suitable for drinking or not. It is a real world problem and it was also the problem description of gecco challenge 2019. The dataset is already provided to us which contains around 1370000 rows and 8 columns along with 6 features and 2 classes. On the basis of dataset we can add water monitoring levels also in it.

ramanaditya commented 4 years ago

@saks1209am, https://github.com/vinitshahdeo/Water-Monitoring-System/issues/15#issuecomment-590696016 we would be quite happy to work upon that idea, but before executing that we need to attain a Minimum viable product. Once the MVP is ready we would love to go with your idea. And of course this is not just a project you can work on this in long run too.

falguniraina commented 4 years ago

can anybody guide me how to get started!! I am a beginner and want to learn by contributing through this !! Also i am unable to find the readme file where i am supposed to make changes?

vinitshahdeo commented 4 years ago

@falguniraina I hope you're familiar with git. If not, please learn the git first and then you can check out our README.md and follow the steps to set up the repo locally. Once it's done, you can start adding code to it.

I would suggest you learn the basics of React(frontend) and Django(backend). For the documentation part, please go through the existing doc present in the repo.

Lemme know if you need any help.

falguniraina commented 4 years ago

ok thanks!!

animeshsrivastava24 commented 4 years ago

@saks1209am @Swarnimashukla Hello, I am too interested in the documentation part. It'll be a great help to share our work and resources to the success of the project.

waridrox commented 4 years ago

Hi there, is there anything regarding html, css and js or should I learn the react framework. I am a newbie but I am familiar with git ?

waridrox commented 4 years ago

Hi there, is there anything regarding html, css and js or should I learn the react framework. I am a newbie but I am familiar with git ?

vinitshahdeo commented 4 years ago

@waridrox It'll be better if you learn React as we're migrating our existing codebase to React.

ramanaditya commented 4 years ago

This is a list of technologies to be used in this project if you are not familiar with them please try to learn their fundamentals. For your convenience, I have linked to their respective documents from where you can learn it better.

Version Control

Languages

Front End

Backend

Server Side:

Databases

Hardware

visit this link https://www.linkedin.com/pulse/getting-started-micropython-nodemcu-esp8266-aditya-raman/ for more info about hardware.

saks1209am commented 4 years ago

Hi @vinitshahdeo . As discussed earlier, me, @Swarnimashukla , @animeshsrivastava24 will be doing the documentation part. Meanwhile, I will help you in the frontend part using HTML, CSS, Javascript , bootstrap along with backend using react and a bit of node.js.

If you need someone for ESP8266 I can do that also as I had created an intrusion detection system with the help of it and Node MCU.

vinitshahdeo commented 4 years ago

@saks1209am Thanks for showing your interest. Looking forward to awesome contributions from you.

I guess there's a typo (backend using react) in your comment. FYI, React is used for the frontend.

animeshsrivastava24 commented 4 years ago

Hello Community, I've a constructive suggestion regarding the project- addition of seepage detection feature. Please can someone assist me with it with their valuable feedback. Opened issue #18 for it with discussion from @ramanaditya .

vinitshahdeo commented 4 years ago

@animeshsrivastava24 I liked your idea, can you please elaborate a bit about the implementation part?

CC: @ramanaditya @PragatiVerma18

ramanaditya commented 4 years ago

@animeshsrivastava24 I liked your idea, can you please elaborate a bit about the implementation part?

CC: @ramanaditya @PragatiVerma18

@animeshsrivastava24 wants to add feature for leakage detection in the water tank using same sensor so no more cost involved and it will be efficient as well.

vinitshahdeo commented 4 years ago

@ramanaditya Will it be feasible for you to integrate it?

animeshsrivastava24 commented 4 years ago

@vinitshahdeo @ramanaditya Since we are using the ultrasonic sensor in our project to detect the rising level of water. We can use it in the reverse manner too, for measuring any fall down in the level of water which may be the result of seepage or water evaporation. Now the water evaporation cases will produce a little to nil effect since our project will keep on monitoring the level in real time with a finite loop time. So it'll be beneficial to add a feature with no additional budget cost. The things to decide will be to add a threshold value and time for fall, as will be done for water rise.

vinitshahdeo commented 4 years ago

@animeshsrivastava24 Thanks for the details. I'll highly appreciate it if you do some homework for fixing threshold/time value. Please coordinate with @ramanaditya to work on the implementation part.

animeshsrivastava24 commented 4 years ago

@vinitshahdeo Sure, I'll do the necessary calculation with help of @ramanaditya and revert back with the work on the opened issue.

minolipvartak commented 4 years ago

@vinitshahdeo hello. I am a GSoC 2020 participant. I want to work on Documentation and the UI of Water Monitoring system.

The suggested format for documentation, from my side, is as follows:

  1. Introduction
  2. Objective (Why we are implementing)
  3. Requirements (hardware devices)
  4. Technologies used
  5. Design (Architecture with few diagrams)
  6. Working
  7. Screenshots
  8. Applications (Areas where this project will be used)
  9. Future Scope
  10. Conclusion
vinitshahdeo commented 4 years ago

@minolipvartak Thanks for showing your interest. Just a small suggestion, please add a section for the tech stack used. Rest LGTM.

minolipvartak commented 4 years ago

@minolipvartak Thanks for showing your interest. Just a small suggestion, please add a section for the tech stack used. Rest LGTM.

Sure @vinitshahdeo . Nice suggestion

vinitshahdeo commented 4 years ago

People interested in backend development, please checkout feature/backend-django branch. Check it here.

Thanks, @ramanaditya for the initial setup

vinitshahdeo commented 4 years ago

@jainpawan21 Thanks for migrating the existing frontend codebase into React. Great job 👏

People interested in working for frontend part, please checkout feature/react-codebase branch.

PragatiVerma18 commented 4 years ago

Please check the updated readme for more instructions, FAQs( frequently asked questions) and important resources. For contributing to the documentation part, check out the feature/documentation branch. Happy Contributing fellas 😃😃😃

ghost commented 4 years ago

@vinitshahdeo I would like to do documentation and frontend part

vinitshahdeo commented 4 years ago

@jyotikrjc Sure, thanks for showing your interest.

daya2940 commented 4 years ago

@vinitshahdeo I would like to work on the front end part

kudos-dot-com commented 4 years ago

Hi,i am a beginner at gssoc and i want to work at frontend and hardware.Is there any issue related to html,css,js or bootstrap.

vinitshahdeo commented 4 years ago

@kudos-dot-com @daya2940 Please check the issues and claim.

vinitshahdeo commented 4 years ago

🔴 🔴 🔴

Hello everyone, we want to assign issues with first-timers-only to absolute beginners who have just started their open source journey.

Please claim this if you're an absolute beginner or this is going to be your first pull request ever.

All the best for GSSoC'20! ✌️

CC: @PragatiVerma18 @jainpawan21 @ramanaditya

vinitshahdeo commented 4 years ago

Everyone - please make the PR to the relevant branch. Check this.

vinitshahdeo commented 4 years ago

🔴 🔴 🔴

📣 To all the beginners,

Please check this to find first-timers-only issues. These issues will be helpful to begin your Open Source journey.

Mit-Patel commented 4 years ago

@vinitshahdeo I would like to work on backend. I am good in Django and want to work in #5

vinitshahdeo commented 4 years ago

Sure @Mit-Patel, please feel free to discuss with @ramanaditya at #5

minolipvartak commented 4 years ago

@PragatiVerma18 I want to write documentation for this project. Can you please assign me the documentation issue?

vinitshahdeo commented 4 years ago

Hello everyone,

There's a small update, this project will be accepting contributions under Rails Girls Summer of Code too.

Tweet by Vinit_Shahdeo

Click here to view the tweet!

Kindly note that the issues labeled with gssoc20 will only be evaluated for the GirlScript Summer of Code. Thankful to everyone for such an awesome response so far.

Keep Contributing! ❤️

vinitshahdeo commented 4 years ago

Hello everyone,

I hope you are all staying safe at your home and enjoying the contribution to your awesome open source projects.

DO THE FIVE: 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

COVID-19: Stay HomeStay Safe

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.

vinitshahdeo commented 4 years ago

Hello everyone,

Thank you so much for your awesome contributions so far. I hope everyone is safe at your home. Turn your self-isolation into self-improvement by learning new things and contributing to open source.

Happy Coding! ❤️


Checkout my latest midnight hack here, a web app for the latest COVID-19 updates.