Skip to content

README.md

Latest commit

 

History

History
115 lines (76 loc) · 2.53 KB

README.md

File metadata and controls

115 lines (76 loc) · 2.53 KB

ArchGen AI

ArchGen AI is an AI-powered platform that generates interactive cloud architecture diagrams and complete technical documentation from simple text descriptions.

It acts as a bridge between conceptual ideas and production-ready system design.

🚀 What ArchGen AI Does

From a single prompt like:

“An e-commerce platform with microservices and payment handling”

ArchGen AI generates:

  • 📊 Interactive architecture diagrams (Mermaid.js)
  • 📘 Complete technical documentation
  • 🧱 Recommended tech stack
  • 🔐 Security & scalability considerations
  • 💰 Cloud cost insights
  • 🧠 Actionable AI prompts & code snippets

All in one place.

✨ Core Features

  • Text → Architecture

    • Converts natural language into structured system designs.

  • Interactive Diagrams

    • Auto-generated and viewable directly in the browser.

  • Full Documentation

    • Architecture overview
    • Technology choices
    • Security & scalability strategies
    • Cost estimation logic

  • AI-Powered Generation

    • Powered by Gemini-3-Flash-Preview via Puter.js SDK.

  • Export Ready

    • Download results as:
      • JSON (programmatic use)
      • Markdown (technical documentation)

  • Progressive Web App

    • Installable on desktop and mobile.

🧠 How It Works

  1. The user enters a system or workflow description.
  2. ArchGen AI processes it using AI reasoning.
  3. The app returns an interactive result view where users can:
    • Explore diagrams
    • Read structured documentation
    • Copy generated prompts and outputs

🏗️ Tech Stack

Frontend

  • React 18
  • TypeScript
  • Tailwind CSS
  • Lucide React
  • Mermaid.js

Platform & AI

  • Puter.js
  • Gemini-3-Flash-Preview

App Features

  • Progressive Web App (PWA)
  • Dark-mode focused UI

📦 Installation (Local Development)

git clone https://github.com/HighMark-31/archgen-ai.git
cd archgen-ai
npm install
npm run dev

🔐 License

This project is released under a custom Non-Commercial License.

See the LICENSE file for full terms.

🧑‍💻 Author & Ownership

Developed and maintained by YecoAI.com – HighMark IT All intellectual property rights are reserved.

For commercial licensing or permissions, contact the owner directly.

🌌 Vision

ArchGen AI aims to democratize system design by making complex cloud architectures accessible, understandable, and actionable — even before a single line of code is written.