🚀 Go-GenAI-Stack

AI-friendly code structure that turns ideas directly into code

English | 中文

Go Version TypeScript License PRs Welcome

Quick Start • Core Features • Architecture • Documentation • Contributing

🚧 This project is currently in very early development stage. Code structure may change at any time, but the goal is to be a production-ready starter for large commercial projects
🎯 This is an experimental attempt at AI-friendly software architecture
💡 Exploring how to make code structure more understandable and generatable by AI

Welcome to discuss and contribute, let's explore best practices for software development in the AI era together!

The core ideas and implementation approach of this project come from:
《Discussion on Possible Changes in Software Architecture and Collaboration Relationships in the AI Era》 ⭐

💡 Why Choose Go-GenAI-Stack?

🎯 Project Positioning

🌟 Standing on the Shoulders of Giants

📁 Project Structure

Go-GenAI-Stack/
├── backend/ # Backend (Go + Hertz + DDD)
│ ├── cmd/ # Application entry
│ │ └── server/ # HTTP Server entry
│ ├── domains/ # Domain layer (Domain-First)
│ │ ├── task/ # Task domain (example implementation) ★
│ │ │ ├── handlers/ # HTTP adapter layer
│ │ │ ├── service/ # Business logic layer
│ │ │ ├── model/ # Domain model
│ │ │ └── ... # Other components
│ │ └── shared/ # Shared components
│ ├── infrastructure/ # Infrastructure layer
│ │ ├── bootstrap/ # Bootstrap
│ │ ├── persistence/ # Persistence (Postgres, Redis)
│ │ ├── middleware/ # Middleware
│ │ ├── config/ # Configuration management
│ │ └── database/ # Database Schema
│ ├── pkg/ # Reusable packages
│ │ └── validator/ # Validator
│ ├── migrations/ # Database migrations
│ │ ├── atlas/ # Atlas migration files & config
│ │ └── seed/ # Seed data
│ ├── shared/ # Shared code
│ │ └── errors/ # Error definitions
│ └── scripts/ # Development scripts
├── frontend/ # Frontend Monorepo
│ ├── web/ # React Web application
│ ├── mobile/ # React Native mobile application
│ └── shared/ # Frontend shared code
│ ├── types/ # TypeScript type definitions
│ ├── utils/ # Utility functions
│ └── constants/ # Constants
├── docs/ # Project documentation
├── docker/ # Docker configuration
└── scripts/ # Project-level scripts

Core Features

🎯 Vibe-Coding-Friendly DDD (Core Highlight)

✅ Vibe-Coding-Friendly Advantages

🧪 Test-Friendly by Design (Playwright / Vitest Ready)

Architecture Highlights

1️⃣ Domain-First

✅ domains/task/ # Organized by business domain
 ├── model/ # Domain model
 ├── service/ # Business logic
 ├── repository/ # Data access
 ├── handlers/ # HTTP adapter layer
 └── tests/ # Tests
❌ Traditional layering (hard to locate functionality):
 ├── controllers/ # All domains mixed together
 ├── services/ # All services mixed together
 └── repositories/ # All repositories mixed together

2️⃣ Self-Contained

3️⃣ Three-Layer Architecture (Clear Layering)

// Handler layer (thin): Only HTTP adaptation
func CreateTaskHandler(c *app.RequestContext) {
 var req dto.CreateTaskRequest
 c.BindAndValidate(&req)
 
 // Call Service layer
 output, err := taskService.CreateTask(ctx, input)
 
 c.JSON(200, response)
}
// Service layer (thick): Business logic ⭐
func (s *TaskService) CreateTask(input CreateTaskInput) {
 // 1. Validate business rules
 // 2. Create domain object
 // 3. Persist
 // 4. Publish event
}
// Repository layer: Data access (database/sql, no ORM)
func (r *TaskRepo) Create(task *Task) error {
 query := `INSERT INTO tasks (...) VALUES (...)`
 _, err := r.db.ExecContext(ctx, query, ...)
 return err
}

🤖 AI-Assisted Development Workflow

# 1️⃣ You: Add new use case in usecases.yaml
vim backend/domains/task/usecases.yaml
# 2️⃣ AI: Reads explicit knowledge files
# - README.md (understand domain boundaries)
# - glossary.md (understand terminology)
# - rules.md (understand business rules)
# - usecases.yaml (understand use case flow)
# 3️⃣ AI: Auto-generates code
# ✅ handlers/new_usecase.handler.go
# ✅ service/task_service.go (new method)
# ✅ http/dto/new_usecase.go
# ✅ tests/new_usecase.test.go
# 4️⃣ You: Run tests and commit
./backend/scripts/test_all.sh
git commit -m "feat(task): add new usecase"

🛠️ Complete Development Toolchain

📊 Production-Grade Observability

// One-click toggle (via config file)
observability:
 logging:
 enabled: true # Logging
 metrics:
 enabled: true # Metrics
 tracing:
 enabled: true # Tracing

🚀 Quick Start

⚡ One-Click Start (Recommended)

# 1️⃣ Clone the project
git clone https://github.com/erweixin/Go-GenAI-Stack.git
cd Go-GenAI-Stack
# 2️⃣ One-click start (Backend + Database)
./scripts/quickstart.sh

🌐 Start Full Stack (Backend + Frontend)

# 1. Start backend (in one terminal)
./scripts/quickstart.sh
# 2. Start frontend (in another terminal)
cd frontend
pnpm install
cd web
pnpm dev

🐳 Docker Production Mode

# Start all services (Backend + Monitoring)
./scripts/start-all.sh

🛠️ Local Development Mode (Manual Setup)

📚 Development Guide

🎯 Common Development Tasks

Documentation

🏗️ Tech Stack

📋 Project Status & Roadmap

✅ v0.1 - Starter (Completed)

🎯 Usage Guide

🔌 Extension Points

🗺️ Future Roadmap

Contributing

💡 How to Contribute

📝 Commit Convention

feat(domain): New feature
fix(domain): Bug fix
docs: Documentation update
refactor(domain): Refactoring
test(domain): Test
chore: Build/toolchain

📊 Project Metrics

🌟 Star History

💬 Community & Support

🔗 References & Resources

Inspiration

Technical Documentation

📄 License

If this project helps you, please give it a ⭐ Star!

Made with ❤️ by Go-GenAI-Stack Team

⬆ Back to Top

Version: v0.1.0 | Status: 🚀 Active Development | Last Updated: 2025年12月02日