Skip to content

Repository files navigation

🌿 VEOS — Voluntary & Ecosystem Operating System

Live Demo GitHub Actions License

React Vite TailwindCSS Gemini API OpenWeatherMap

A unified, state-of-the-art environmental operating system bridging real-time climate telemetry, crowdsourced hazard reporting, AI assistant, community action, and sustainable eco-commerce.

Explore Live Web App · Report an Issue · Request Feature


📋 Table of Contents


🌟 System Overview

Environmental degradation, climate volatility, and illegal waste dumping demand immediate, synchronized action. VEOS was engineered to eliminate the gap between environmental monitoring data and field-level intervention.

By bringing together satellite tile maps, live weather API telemetry, crowdsourced citizen hazard reports, AI conversational intelligence, and gamified volunteer incentives, VEOS provides a single operational platform for citizens, NGOs, corporate sponsors, and government inspectors.


🏗️ Platform Architecture

                                  +---------------------------------------+
                                  |         VEOS Platform Core            |
                                  +---------------------------------------+
                                                      |
         +--------------------+-----------------------+-----------------------+--------------------+
         |                    |                       |                       |                    |
         v                    v                       v                       v                    v
+------------------+ +------------------+   +-------------------+   +------------------+ +-------------------+
| Live Telemetry   | | EcoAI Voice Assistant| | Hazard Reporting|   | Community Engine | | Eco Marketplace   |
| (OpenWeatherMap /| | (Google Gemini  |   | (Geotagged Issue  |   | (Volunteer Drives| | (Redeem Points for|
| Leaflet Tiles)   | | 1.5 Flash API)   |   | Tracking & Gov)   |   | & Certificates)  | | Solar Vouchers)   |
+------------------+ +------------------+   +-------------------+   +------------------+ +-------------------+
         |                    |                       |                       |                    |
         +--------------------+-----------------------+-----------------------+--------------------+
                                                      |
                                                      v
                                    +-----------------------------------+
                                    | Multi-Stakeholder Portals         |
                                    | (Citizen | NGO | Gov | Corporate) |
                                    +-----------------------------------+

✨ Core Modules & Features

1. 📡 Live Climatology & Weather Telemetry

  • Interactive Leaflet Canvas: Switch seamlessly between OpenStreetMap, Political Map, and ArcGIS Satellite Imagery.
  • Multi-Source Weather API Integration: Dual-mode engine supporting OpenWeatherMap & Visual Crossing Timeline APIs.
  • Real-Time Environmental Metrics: Instant tracking of Temperature (°C), Humidity (%), Wind Speed (km/h), Cloud Cover (%), and Sunrise/Sunset times for any global city or GPS coordinate.
  • Category Map Overlays: Radar/Precipitation, Temperature heatmap, Wind velocity, and Cloud density tiles.

2. 🤖 EcoAI Voice Assistant

  • Generative AI Assistant: Powered by Google Gemini 1.5 Flash for intelligent ecological analysis, environmental law guidance, and platform navigation.
  • Voice Recognition (Speech-to-Text): Hands-free voice querying built using the Web Speech API with automatic query submission.
  • Interactive Link Routing: AI responses generate clickable navigation buttons directing users to specific platform tools.
  • Smart Local Fallback: Instant local response engine ensures uninterrupted guidance even offline or when rate limited.

3. ⚠️ Environmental Incident & Hazard Reporting

  • Grassroots Reporting: Log reports on illegal dumping, deforestation, industrial emissions, and water contamination.
  • Geotagged Hazard Pipeline: Upload photographic evidence, assign severity tiers (Low, Medium, Critical), and track resolution stages.
  • Municipal Oversight: Status progression from Reported ➔ Under Inspection ➔ Resolved.

4. 👥 Community Action, Volunteering & Leaderboards

  • Volunteering Drives: Join local tree planting initiatives, beach cleanups, and neighborhood recycling groups.
  • Gamified Eco Points: Earn points for verified eco-actions, completed volunteer drives, and incident reporting.
  • Certificates & Leaderboards: Download verified volunteer certificates and view community rankings.

5. 🎓 Climate Academy & Knowledge Hub

  • Educational Courses: Structured learning modules on carbon footprint reduction, zero-waste living, and renewable energy.
  • Research & Media: Podcast episodes, citizen environmental law primers, and downloadable research PDFs.

6. 🛍️ Eco Marketplace & Points Engine

  • Reward Redemption: Trade accumulated Eco Points for eco-friendly products, bamboo merchandise, solar energy vouchers, and verified carbon offset badges.

7. 🏢 Multi-Stakeholder Governance Portals

  • Tailored Views: Custom dashboards for Citizens, NGO Administrators, Municipal Directorate, Schools, and Corporate ESG Sponsors.

📁 Project Structure

VEOS/
├── .github/
│   └── workflows/
│       └── deploy.yml            # GitHub Actions CI/CD deployment workflow
├── src/
│   ├── assets/                   # Static branding images & icons
│   ├── components/               # Reusable UI components
│   │   ├── auth/                 # Authentication modals
│   │   ├── community/            # Rewards & volunteer cards
│   │   ├── volunteer/            # Leaderboards, certificates & registration
│   │   ├── AIAssistant.jsx       # Gemini-powered EcoAI floating drawer
│   │   ├── Footer.jsx            # Platform footer navigation
│   │   └── Header.jsx            # Responsive navigation header
│   ├── constant/                 # Global navigation & data constants
│   ├── pages/                    # Main route pages
│   │   ├── About.jsx             # About VEOS ecosystem
│   │   ├── Academy.jsx           # Educational courses
│   │   ├── Climatology.jsx       # Live weather & Leaflet tile map
│   │   ├── Community.jsx         # Community volunteer hub
│   │   ├── Contact.jsx           # Contact & support
│   │   ├── CorporatePortal.jsx   # Corporate ESG dashboard
│   │   ├── Dashboard.jsx         # Telemetry & activity analytics
│   │   ├── Hero.jsx              # Main landing hero page
│   │   ├── Issues.jsx            # Incident reporting dashboard
│   │   ├── Knowledge.jsx         # Articles, podcasts & primers
│   │   ├── MarketPlace.jsx       # Eco points redemption shop
│   │   ├── NGOPortal.jsx         # NGO partner portal
│   │   ├── Petitions.jsx         # Grassroots advocacy petitions
│   │   ├── Portals.jsx           # Portal selection overview
│   │   ├── ProfilePage.jsx       # User profile & eco achievements
│   │   └── SchoolPortal.jsx      # Youth climate education portal
│   ├── App.jsx                   # Central layout & route table
│   ├── App.css                   # Global component styles
│   ├── index.css                 # Tailwind CSS directives & theme configuration
│   └── main.jsx                  # React DOM root entry (HashRouter)
├── .env.example                  # Environment variable reference template
├── eslint.config.js              # ESLint configuration
├── index.html                    # Single page application entry HTML
├── package.json                  # Dependencies & npm scripts
├── README.md                     # Comprehensive project documentation
└── vite.config.js                # Vite build configuration (base path & envPrefix)

⚙️ Environment Configuration

To configure environment variables for local development or custom deployments, create a .env file in the root directory:

# Google Gemini API Key for EcoAI Assistant
API="your_gemini_api_key"
VITE_API="your_gemini_api_key"
VITE_GEMINI_API_KEY="your_gemini_api_key"

# Weather API Key (OpenWeatherMap or Visual Crossing)
VITE_WEATHER_API_KEY="your_weather_api_key"
VITE_VISUAL_CROSSING_API_KEY="your_weather_api_key"

Note: In Vite, client-exposed variables are prefixed with VITE_ or allowed prefixes (API) as configured in vite.config.js.


💻 Local Installation & Setup

Follow these steps to run VEOS locally on your system:

Prerequisites

  • Node.js: v18.0.0 or higher
  • npm: v9.0.0 or higher

1. Clone the repository

git clone https://github.com/Jaswanthsskatt/VEOS.git
cd VEOS

2. Install dependencies

npm install

3. Start development server

npm run dev

Open your browser and navigate to http://localhost:5173.

4. Build production bundle

npm run build

5. Preview production build locally

npm run preview

🚀 Automated CI/CD & Deployment

VEOS is configured with an automated GitHub Actions deployment pipeline located in .github/workflows/deploy.yml.

Deployment Pipeline Flow:

  1. Trigger: Pushing code updates to the main branch.
  2. Build Stage: Sets up Node.js 20 environment, installs dependencies, compiles Vite production bundle into ./dist.
  3. Deploy Stage: Deploys the built SPA bundle directly to GitHub Pages at: 👉 https://jaswanthsskatt.github.io/VEOS/

🤝 Contributing

Contributions to VEOS are warmly welcomed! To contribute:

  1. Fork the repository (https://github.com/Jaswanthsskatt/VEOS/fork)
  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.


Made with ❤️ for Planet Earth 🌍 | VEOS Ecosystem Platform

About

Voluntary & Ecosystem Operating System (VEOS) — A unified platform for real-time climate telemetry, environmental hazard reporting, AI assistance, community action, and sustainable eco-rewards.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages