https://github.com/047pegasus/geowelladvisor
Official SIH project by Team Pegasus | Lead by me and powered by everyone. 🚀❤️
https://github.com/047pegasus/geowelladvisor
backend frontend-web geolocation india ml sih2023 well
Last synced: 5 months ago
JSON representation
Official SIH project by Team Pegasus | Lead by me and powered by everyone. 🚀❤️
- Host: GitHub
- URL: https://github.com/047pegasus/geowelladvisor
- Owner: 047pegasus
- License: gpl-3.0
- Created: 2023-09-18T02:43:08.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-10-07T09:36:09.000Z (over 2 years ago)
- Last Synced: 2024-05-03T03:49:57.000Z (about 2 years ago)
- Topics: backend, frontend-web, geolocation, india, ml, sih2023, well
- Language: JavaScript
- Homepage: https://geowelladvisor.pages.dev/
- Size: 7.36 MB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
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](#about-the-project)
* [Built With](#built-with)
* [Getting Started](#getting-started)
* [Prerequisites](#prerequisites)
* [Installation](#installation)
* [Usage](#usage)
* [Roadmap](#roadmap)
* [Contributing](#contributing)
* [License](#license)
* [Authors](#authors)
* [Acknowledgements](#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](https://react.dev/)
* [Vite](https://vitejs.dev/)
* [Flutter](https://flutter.dev/)
* [Python Anywhere](https://www.pythonanywhere.com/user/047pegasus/)
* [Leaflet JS](https://leafletjs.com/)
## 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
```sh
npm install npm@latest -g
```
### Installation
1. Clone the repo
```sh
git clone https://github.com/047pegasus/GeoWellAdvisor.git
```
2. Install NPM packages
```sh
npm install
```
3. Run the app using Vite and enjoy!!
```sh
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](https://github.com/047pegasus/GeoWellAdvisor/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](https://github.com/047pegasus/GeoWellAdvisor/issues/new) 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](https://github.com/047pegasus/GeoWellAdvisor/blob/main/CODE_OF_CONDUCT.md) 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](https://github.com/047pegasus/GeoWellAdvisor/blob/main/LICENSE.md) for more information.
## Authors
* **Tanishq Agarwal** - *Backend Expert | Project Team Lead * - [Tanishq Agarwal](https://github.com/047pegasus) - *Built Backend for the Application*
* **Ayushi Dwivedi** - *ML Developer* - [Ayushi Dwivedi](https://github.com/damncode12) - *Built the Prediction Models using ML*
* **Satyam Gupta** - *Frontend Developer* - [Satyam Gupta](https://github.com/SatyamGuptaDev) - *Built the WebApp Frontend*
* **Satyam Singh** - *Frontende Developer* - [Satyam Singh](https://github.com/satyam0327) - *Built the WebApp Dashboard Frontend*
* **Avni Jain** - *ML Developer* - [Avni Jain](https://linkedin.com/in/avni-jain-b528a9228) - *Built the Prediction Models using ML*
* **Aditya Sachan** - *Flutter Developer* - [Aditya Sachan](https://github.com/Sachan-aditya) - *Built the Android Port of the Application*
## Acknowledgements
* [Stable Diffusion XL](https://clipdrop.co/stable-diffusion)
* [Undraw Illustrations](https://undraw.co/illustrations)
* [GeoWell Android by Aditya Sachan](https://github.com/Sachan-aditya/geowell)
* [AOS JS](https://github.com/michalsnik/aos)