https://github.com/askitendo/hyjal2
Smart water management for sustainable urban communities.
https://github.com/askitendo/hyjal2
Last synced: 2 months ago
JSON representation
Smart water management for sustainable urban communities.
- Host: GitHub
- URL: https://github.com/askitendo/hyjal2
- Owner: AskitEndo
- Created: 2024-10-26T07:01:58.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-01-23T13:35:09.000Z (5 months ago)
- Last Synced: 2025-03-25T09:21:24.075Z (3 months ago)
- Language: JavaScript
- Homepage: http://hyjal2.netlify.app/
- Size: 426 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Hyjal Project 
**Hyjal** is a smart water management platform designed to promote sustainability and improve access to clean water in urban communities. Built using the MERN stack (MongoDB, Express, React, Node.js), it allows users to seamlessly donate and collect water while leveraging location-based pin-code precision for efficient resource distribution. Hyjal’s mobile-friendly and scalable design ensures accessibility across devices, encouraging community participation in water conservation efforts. By integrating technology with sustainability goals, Hyjal aims to address water scarcity and hygiene challenges, fostering a collective approach toward a healthier and more sustainable future.
Built with 💓 & 🧠 to be mobile-friendly, scalable, and accessible! Dive into the details and discover how this platform can change the way we think about water management.
---
## 🌟 **Key Features**
- 🌍 **Pin-Code-Based Operations**: Bringing precision to water management.
- 📱 **Mobile-Friendly Design**: A seamless experience on any device.
- 🚀 **Online Scalability**: Ready to grow alongside your community.
- 🛠️ **MERN Stack**: A robust backend and a stylish frontend.
- 💧 **Sustainability Focused**: Supporting global water conservation goals.
---
## 🚀 **CHECKOUT!**
> 
> 
> 
> 
> 
---
## 🔧 **Backend Setup**
1. **Clone the Repository**:
```bash
git clone https://github.com/AskitEndo/Hyjal2
cd server
```
2. **Install Dependencies**:
```bash
npm install
```
3. **Set Up Environment Variables**:
- Create a `.env` file:
```env
MONGO_URI=mongodb://localhost:27017/hyjal
PORT=5000
```
4. **Run the Backend**:
```bash
npm start
```
Backend runs on `http://localhost:5000`.
---
## 🎨 **Frontend Setup**
1. **Navigate to the Frontend**:
```bash
cd client
```
2. **Install Frontend Dependencies**:
```bash
npm install
```
3. **Start the Development Server**:
```bash
npm run dev
```
It will be live at `http://localhost:3000`.
4. Already deployed! Check out the [Live Website](https://hyjal2.netlify.app/).
---
## 🌍 **Published Online**
The frontend is deployed on **Netlify** for wide availability and optimal performance,With local Data created for dummy purpose. This ensures smooth, mobile-friendly access anytime and anywhere. 🌟
---
## 🤝 **Team Coders**
AskitEndo
Backend/Scrum Master
nothingADSR123
Frontend
sreetamKasta
User Data Analytics
BharatCodingLad
Website Pipelining
The Team behind HyJal. 
---
## 🛠️ **Tech Stack & Pros & Cons**
### **Tech Stack**
| **Technology** | **Purpose** |
| ---------------- | ------------------- |
| **MongoDB** | Database Management |
| **Express.js** | Backend Framework |
| **React (Vite)** | Frontend Framework |
| **Node.js** | Server-side Logic |
| **Tailwind CSS** | Frontend Styling |
---
### **Pros & Cons**
| **Pros** | **Cons** |
| -------------------------------- | ----------------------------------- |
| Encourages water sustainability | Requires prior technical knowledge |
| Mobile-friendly and scalable | Complex for large-scale integration |
| Pin-code precision for donations | Dependency on local database setup |
Stay sustainable, save water, and keep growing! 🌊