README.md

Struct AI

AI-powered documentation infrastructure for engineering teams.

Struct AI transforms repositories and raw source code into clean, production-ready README files. Upload a ZIP or paste code — Struct analyzes your project structure and generates polished markdown documentation using Gemini API.

---

Installation

Prerequisites: Node.js 18+, a Gemini API key

# Clone the repo
git clone https://github.com/ash1shkumar/struct.git
cd struct

# Install dependencies
npm install

# Set up environment
cp .env.example .env
# → Add your GEMINI_API_KEY to .env

# Start the server
npm start

Open http://localhost:3000 in your browser.

---

Usage

1. Upload a .zip repository or paste raw source code
2. Select Concise or Detailed documentation style
3. Click Generate Documentation
4. Copy or download your README.md

---

Tech Stack

---

Project Structure

struct/
│
├── public/
│       ├── struct.png
│       └── bg_no_logo.png
│
├── src/
│   ├── script.js
│   └── style.css
│
├── server/
│   └── server.js
│
├── index.html          
├── .env.example        
├── .gitignore
├── package.json
└── package-lock.json

---

Contributing

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

---

License

Distributed under the MIT License. See LICENSE for details.

---

_{Built by Ashish Kumar}