Solar-Hydrogel-Panels

Stars
6
Language
TypeScript
Updated
View on GitHubLive site

Hydrogenius Flow

A responsive React + Vite starter project focused on visualizing system architecture and simulation components. This repository contains UI components, simulation hooks, and visualization helpers intended to support a prototype application for energy systems design and analysis.

Badges

  • Build: Vite Build
  • License: MIT
  • Tests: Vitest
  • Source: src/
  • Entry: index.html → src/main.tsx
  • Components: src/components/
  • Pages: src/pages/

Getting started

Prerequisites

  • Node.js (>= 18)
  • npm or pnpm or yarn

Install

npm install

Run development server

npm run dev

Build for production

npm run build

Run tests

npm run test

Project structure

  • index.html — HTML entry, mounts #root and loads src/main.tsx.
  • src/main.tsx — application bootstrap.
  • src/App.tsx — root React component.
  • src/components/ — UI primitives, sections, simulations, and visualizations.
  • src/hooks/ — custom hooks (mobile detection, toasts).
  • src/lib/ — utilities.
  • src/pages/ — route pages.

Key components

  • components/sections/ — high-level layout sections (Hero, Roadmap, Architecture).
  • components/simulation/ClimateSimulation.tsx — example simulation visualization.
  • components/visualizations/Panel3DViewer.tsx — 3D panel viewer for models.

Configuration & environment

  • Vite config: vite.config.ts
  • TypeScript config: tsconfig.json and tsconfig.app.json
  • Tailwind: tailwind.config.ts and index.css for utilities
  1. Create a feature branch: git checkout -b feat/your-feature
  2. Implement components under src/components and pages under src/pages.
  3. Add unit tests to src/test and run npm run test.
  4. Open a Pull Request and request a review.

Contributing

Contributions are welcome. Please open an issue first to discuss major changes. Follow these guidelines:

  • Keep changes small and focused.
  • Add or update tests for new behavior.
  • Ensure linting and types pass locally.

License

This project is provided under the MIT License. See LICENSE for details.

Contact

For questions or help, open an issue in this repository.

Acknowledgements

This repo was bootstrapped with a lightweight template and extended with components for system visualization and simulation.