Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Mackenzie-OO7/Helios

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Helios ☀️

Your AI-powered solar energy consultant for Nigeria. Design the perfect solar system, get accurate pricing, and connect with verified suppliers, all in one platform.

Overview

Helios is a comprehensive web application that helps Nigerians navigate the complex world of solar power systems. From initial consultation to supplier connections, we provide end-to-end guidance for anyone looking to install solar energy in their homes or businesses.

📁 Project Structure

This is a monorepo containing both frontend and backend:

helios/
├── frontend/         # Frontend (React + TypeScript + Vite)
│   ├── src/
│   │   ├── components/   # React components
│   │   ├── pages/        # Page components
│   │   ├── context/      # React Context
│   │   └── hooks/        # Custom hooks
│   ├── index.html
│   ├── vite.config.js
│   └── package.json
├── backend/          # Backend API (Node.js + Express)
│   ├── src/
│   │   ├── config/       # Firebase, OpenAI, SendGrid, PostHog
│   │   ├── routes/       # API endpoints
│   │   ├── services/     # Business logic
│   │   ├── middleware/   # Auth, rate limiting
│   │   └── index.js      # Express server
│   └── README.md         # Backend documentation
├── email-templates/  # SendGrid email HTML templates
└── README.md         # This file

Quick Start

Frontend:

cd frontend
npm install
cp .env.example .env  # Configure your environment variables
npm run dev
# http://localhost:5173

Backend:

cd backend
npm install
cp .env.example .env  # Configure your API keys
npm run dev
# http://localhost:3001

See backend/README.md for detailed backend setup.

Why Helios?

Nigeria faces significant power challenges, and solar energy is increasingly becoming a viable solution. However, most people struggle with:

  • Sizing confusion: Not knowing what capacity system they need
  • Price opacity: No standardized pricing information
  • Technical jargon: Complex solar terminology
  • Supplier trust: Finding reliable suppliers and installers

Helios solves all these problems in one platform.

Features

1. AI Solar Expert (Icarus)

Chat with our intelligent AI consultant that speaks both English and Pidgin. Get personalized recommendations based on your:

  • Location
  • Power needs
  • Budget constraints
  • Usage patterns

2. Smart Load Calculator

Calculate your exact power requirements in minutes:

  • Pre-loaded Nigerian-specific appliances with accurate wattage
  • Categories: Cooling, Kitchen, Lighting, Entertainment, Security
  • Automatic system sizing recommendations
  • Real-time power consumption calculations
  • Save your calculations and download as a pdf or use as context with Icarus

3. Verified Providers Directory

  • Browse suppliers and installers across major Nigerian cities
  • See recent pricing for components/services
  • Check credentials and certifications
  • View completed projects
  • Verified ratings and reviews
  • Direct WhatsApp contact
  • Filter by location and specialty

4. Lumina Token System (DePIN)

  • Lumina (LUM) token rewards users for verified solar generation.
  • 3-Tier Verification for trust and accuracy:
    • Tier 1: Basic (photo verification)
    • Tier 2: Manual (bill + photo)
    • Tier 3: IoT (automatic smart device)
  • Trust scores affect token mint rates.
  • Immutable data storage via Hedera Consensus Service (HCS).

5. Energy Dashboard

  • Tracks daily energy production.
  • Displays LUM balance (minted, pending, total).
  • Weather-based generation forecasting.

6. Jargon Buster

Learn solar terminology in simple context:

  • Batteries (Deep Cycle, Tubular, AGM, Lithium)
  • MPPT Controllers
  • KVA vs Watts
  • And much more...

7. Premium Features (Micro-payments via Fiat/Crypto)

  • Detailed System Specs PDF (₦500): Complete technical specs, wiring diagrams, installation guide
  • Supplier Connections (₦1,000): Direct access to verified suppliers with quotes
  • Full Consultation Package (₦2,000): Personal consultation, system manual, installer quotes, price alerts

Tech Stack

Core

  • React 18.2 - UI library
  • TypeScript - Type safety
  • Vite 5.4 - Build tool and dev server
  • React Router v6 - Client-side routing

Styling

  • Tailwind CSS 3.4 - Utility-first CSS framework
  • PostCSS - CSS processing
  • Autoprefixer - Vendor prefix automation

State Management

  • React Context API - Global state management
  • React Hooks - Local state and effects

Blockchain & Payments

  • Dynamic Labs (@dynamic-labs/sdk-react-core) - Web3 authentication for easy login with email
  • RainbowKit - Wallet connection UI (as a backup)
  • Wagmi - React hooks for Ethereum
  • Viem - TypeScript Ethereum client

UI/UX

  • Lucide React - Icon library
  • React Hot Toast - Toast notifications

HTTP Client

  • Axios - API requests
  • x402-axios - Payment-enabled HTTP requests

Additional Tools

  • OpenAI SDK - AI integration (future)
  • jsPDF - PDF generation for reports

📊 Nigerian Market Data

All pricing, appliance wattages, and recommendations are based on real Nigerian market data:

Supported Cities

  • Lagos
  • Abuja
  • Port Harcourt
  • Ibadan
  • Enugu
  • Kaduna
  • And more...

AI Features

Icarus - The AI Solar Expert

Our conversational AI helps users through a structured consultation process:

  1. Location Detection: Identifies user's city for local recommendations
  2. Goal Assessment: Understands user's solar objectives
  3. Budget Alignment: Matches solutions to budget constraints
  4. Load Analysis: Guides through appliance selection
  5. System Design: Generates custom system recommendations

Localization

Helios is built with Nigerians in mind:

  • Currency: Nigerian Naira (₦)
  • Language: English and Pidgin support
  • Appliances: Nigeria-specific power ratings
  • Weather: Solar irradiance data for Nigerian regions
  • Grid: NEPA/utility grid context

Responsive Design

Fully responsive across all devices:

  • Mobile: Optimized touch interfaces, bottom navigation
  • Tablet: Adaptive grid layouts
  • Desktop: Full-featured experience with sidebars

🤝 Contributing

We welcome contributions! Here's how you can help:

  1. Fork the repository
  2. Create a feature branch
    git checkout -b feature/amazing-feature
  3. Commit your changes
    git commit -m 'Add some amazing feature'
  4. Push to the branch
    git push origin feature/amazing-feature
  5. Open a Pull Request

Contribution Guidelines

  • Follow the existing code style
  • Write meaningful commit messages
  • Update documentation as needed
  • Test your changes thoroughly
  • Keep PRs focused on a single feature/fix

🐛 Bug Reports

Found a bug? Please open an issue with:

  • Clear description of the problem
  • Steps to reproduce
  • Expected vs actual behavior
  • Screenshots (if applicable)
  • Browser/device information.

Authors

  • Levai

💡 FAQ

Q: Is Helios free to use? A: Yes! Core features (AI chat, calculator, basic recommendations) are completely free. Premium features cost ₦500-₦2,000.

Q: Do I need cryptocurrency to use Helios? A: Only for premium features. Basic features are free and don't require crypto.

Q: Are the prices accurate? A: Prices are based on real market data and updated regularly, but always confirm with suppliers.

Q: Can I use this outside Nigeria? A: The app is optimized for Nigeria, but the calculator works anywhere. Pricing may not be accurate for other countries.

Q: How do I become a verified supplier/installer? A: Register on the platform with your business details. Approval may take up to 24 hours

Project Goals

  1. Democratize Solar Knowledge: Make solar energy accessible to all Nigerians
  2. Price Transparency: Eliminate information asymmetry in solar market
  3. Quality Assurance: Connect users with verified, trustworthy suppliers and installers
  4. Education: Build solar literacy across Nigeria
  5. Sustainability: Accelerate Nigeria's renewable energy adoption

Other Info

Pitch Deck: https://drive.google.com/file/d/1J9adJchhrlrlJkAy68iqROFKl360Q3je/view?usp=sharing

Hedera Certification link: https://certs.hashgraphdev.com/3243da31-3026-4241-8448-a9ba2208aae1.pdf

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published