search

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 263 forks source link

Include a UML diagram in the readme.md #50

Open PragatiVerma18 opened 4 years ago

PragatiVerma18 commented 4 years ago

Is your feature request related to a problem? Please describe. UML is a modern approach to modelling and documenting software. It is based on diagrammatic representations of software components. Since it’s one of the most popular business process modelling techniques, we must include a UML diagram.

Describe the solution you'd like UML diagram serves as a complete design that requires solely the actual implementation of the system or software. Hence, give a blueprint of the project through a UML diagram.

habeeba-naaz commented 4 years ago

Hi ...I am gssoc20 participant .interested to work on this..please assign me...if possible

PragatiVerma18 commented 4 years ago

Hi @habeeba-naaz!! Happy to see that you want to contribute. Please share your idea regarding this issue and make sure you have read everything about this project.

habeeba-naaz commented 4 years ago

To monitor status of the system , we can use this Unified Modeling Language (UML Diagram) . I thought of using some free software to show this representation. We can show basically decisions on this diagram-Like if water overflowing /depleted then Danger zone occurs, if water is about to overflow/depleted Warning zone occurs and if water is in it’s limit then safe zone takes place

saks1209am commented 4 years ago

I now how to create good diagrams and I can do this work

vinitshahdeo commented 4 years ago

@habeeba-naaz Hey assigning you this issue. Thanks for showing your interest.

habeeba-naaz commented 4 years ago

Thank you for assigning

habeeba-naaz commented 4 years ago

Please explain context of this project..I mean explain coding in src folder in brief such that it can easily design if possible?

PragatiVerma18 commented 4 years ago

This project aims at reducing water wastage through tank overflow, hence, we are using IoT devices and alarm mechanisms to alert the owner of the tank when the water level is about to overflow or is about to deplete. We are currently planning to make a React+Django project framework such that we will keep all our data in rest APIs where any owner can signup and login to keep track of his/her tanks. Any other questions @habeeba-naaz ??

habeeba-naaz commented 4 years ago

Thank you for answering...so from which file I can find classes,attributes...if so please explain relationship between them to design class diagrams

habeeba-naaz commented 4 years ago

Actually I found jquery in SRC folder...If I could understand what’s going on..it will be easy

PragatiVerma18 commented 4 years ago

Which branch are you looking into?

Actually I found jquery in SRC folder...If I could understand what’s going on..it will be easy

habeeba-naaz commented 4 years ago

Master...in which branch should I look for fronted?

PragatiVerma18 commented 4 years ago

Master...in which branch should I look for fronted?

look into feature\frontend branch for the new frontend changes. We are now planning to move to react based frontend.

habeeba-naaz commented 4 years ago

Okay...thank you