047pegasus/geowelladvisor

Official SIH project by Team Pegasus | Lead by me and powered by everyone. 🚀❤️

GeoWell Advisor

Official SIH 2023 project by Team Pegasus | Lead by me and powered by everyone. 🚀❤️

View Demo . Report Bug . Request Feature

Table Of Contents

• About the Project
• Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Authors
• Acknowledgements

About The Project

GeoWell Advisor is a powerful tool designed to help users determine the feasibility of digging a well at a specific location. Whether you are a farmer, a land developer, or simply someone interested in exploring groundwater resources, GeoWell Advisor provides you with essential information and insights to make informed decisions about well placement.

Built With

This section should list any major frameworks that you built your project using. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

• React
• Vite
• Flutter
• Python Anywhere
• Leaflet JS

Getting Started

In order to get started with the project locally, we first need to install the latest Node Package Manager (npm) version.

Prerequisites

To update npm, we need to perform the follwing:

• npm

npm install npm@latest -g

Installation

1. Clone the repo

git clone https://github.com/047pegasus/GeoWellAdvisor.git

2. Install NPM packages

npm install

3. Run the app using Vite and enjoy!!

npm run dev

Usage

GeoWell Advisor offers multiple ways to input location information, making it easy for users to analyze potential well sites. Whether you prefer using live location, selecting a specific address on a map, or choosing a location from a dropdown menu, GeoWell Advisor has you covered. Both the web application and Android app provide these convenient options for location input.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

• If you have suggestions for adding or removing projects, feel free to open an issue to discuss it, or directly create a pull request after you edit the README.md file with necessary changes.
• Please make sure you check your spelling and grammar.
• Create individual PR for each suggestion.
• Please also read through the Code Of Conduct before posting your first idea as well.

Creating A Pull Request

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Authors

• Tanishq Agarwal - *Backend Expert | Project Team Lead * - Tanishq Agarwal - Built Backend for the Application
• Ayushi Dwivedi - ML Developer - Ayushi Dwivedi - Built the Prediction Models using ML
• Satyam Gupta - Frontend Developer - Satyam Gupta - Built the WebApp Frontend
• Satyam Singh - Frontende Developer - Satyam Singh - Built the WebApp Dashboard Frontend
• Avni Jain - ML Developer - Avni Jain - Built the Prediction Models using ML
• Aditya Sachan - Flutter Developer - Aditya Sachan - Built the Android Port of the Application

Acknowledgements

• Stable Diffusion XL
• Undraw Illustrations
• GeoWell Android by Aditya Sachan
• AOS JS