Update README with complete merged structure documentation

This commit is contained in:
uroma
2026-02-13 10:09:09 +00:00
Unverified
parent c5919d56c8
commit 7c68dfac7b

317
README.md
View File

@@ -1,60 +1,124 @@
# 🚀 Welcome to Z.ai Code Scaffold
# GLM Tools, Skills & Agents
A modern, production-ready web application scaffold powered by cutting-edge technologies, designed to accelerate your development with [Z.ai](https://chat.z.ai)'s AI-powered coding assistance.
Comprehensive collection of AI platform skills, expert agents, and development tooling from MiniMax, Super Z (GLM), and z.ai platforms.
## ✨ Technology Stack
---
This scaffold provides a robust foundation built with:
## Repository Structure
### 🎯 Core Framework
- **⚡ Next.js 16** - The React framework for production with App Router
- **📘 TypeScript 5** - Type-safe JavaScript for better developer experience
- **🎨 Tailwind CSS 4** - Utility-first CSS framework for rapid UI development
```
GLM-Tools-Skills-Agents/
├── src/ # Next.js 16 application source
│ ├── app/ # App Router pages
│ ├── components/ui/ # 50+ shadcn/ui components
│ ├── hooks/ # Custom React hooks
│ └── lib/ # Utilities (db, utils)
├── skills/ # Claude Code compatible skills
│ ├── minimax-experts/ # 40 AI experts from MiniMax
│ ├── glm-skills/ # Super Z/GLM multimodal skills
│ ├── zai-tooling-reference/ # Next.js 16 patterns
│ └── ai-platforms-consolidated/ # Cross-platform reference
├── codebases/ # Reference codebases
│ └── z-ai-tooling/ # Full Next.js 16 project copy
├── original-docs/ # Original source documentation
│ ├── minimax_experts_data.md # MiniMax experts JSON
│ ├── MINIMAX_EXPERT_CATALOG.md # MiniMax catalog
│ └── GLM5_AGENTS_AND_SKILLS.md # Super Z agents & skills
├── prisma/ # Prisma schema
├── examples/ # WebSocket examples
├── db/ # SQLite database
└── .zscripts/ # Build & deploy scripts
```
### 🧩 UI Components & Styling
- **🧩 shadcn/ui** - High-quality, accessible components built on Radix UI
- **🎯 Lucide React** - Beautiful & consistent icon library
- **🌈 Framer Motion** - Production-ready motion library for React
- **🎨 Next Themes** - Perfect dark mode in 2 lines of code
---
### 📋 Forms & Validation
- **🎣 React Hook Form** - Performant forms with easy validation
- **✅ Zod** - TypeScript-first schema validation
## Skills Overview
### 🔄 State Management & Data Fetching
- **🐻 Zustand** - Simple, scalable state management
- **🔄 TanStack Query** - Powerful data synchronization for React
- **🌐 Fetch** - Promise-based HTTP request
### 1. MiniMax Experts (`skills/minimax-experts/`)
### 🗄️ Database & Backend
- **🗄️ Prisma** - Next-generation TypeScript ORM
- **🔐 NextAuth.js** - Complete open-source authentication solution
40 AI experts from the MiniMax platform (agent.minimax.io):
### 🎨 Advanced UI Features
- **📊 TanStack Table** - Headless UI for building tables and datagrids
- **🖱️ DND Kit** - Modern drag and drop toolkit for React
- **📊 Recharts** - Redefined chart library built with React and D3
- **🖼️ Sharp** - High performance image processing
| Category | Count | Top Experts |
|----------|-------|-------------|
| Content Creation | 12 | Landing Page Builder, Visual Lab, Video Story Generator |
| Finance | 7 | Hedge Fund Expert Team, Crypto Trading Agent |
| Development | 5 | Mini Coder Max, Peak Coder, Prompt Development Studio |
| Career | 5 | Job Hunter Agent, CV Optimization Expert |
| Business | 3 | PRD Assistant, SaaS Niche Finder, CEO Assistant |
| Marketing | 2 | Social Media Marketing Expert, Creative Director For Ads |
### 🌍 Internationalization & Utilities
- **🌍 Next Intl** - Internationalization library for Next.js
- **📅 Date-fns** - Modern JavaScript date utility library
- **🪝 ReactUse** - Collection of essential React hooks for modern development
**Auto-Triggers:** agent design, trading, landing pages, PRD, CV optimization
## 🎯 Why This Scaffold?
### 2. GLM Skills (`skills/glm-skills/`)
- **🏎️ Fast Development** - Pre-configured tooling and best practices
- **🎨 Beautiful UI** - Complete shadcn/ui component library with advanced interactions
- **🔒 Type Safety** - Full TypeScript configuration with Zod validation
- **📱 Responsive** - Mobile-first design principles with smooth animations
- **🗄️ Database Ready** - Prisma ORM configured for rapid backend development
- **🔐 Auth Included** - NextAuth.js for secure authentication flows
- **📊 Data Visualization** - Charts, tables, and drag-and-drop functionality
- **🌍 i18n Ready** - Multi-language support with Next Intl
- **🚀 Production Ready** - Optimized build and deployment settings
- **🤖 AI-Friendly** - Structured codebase perfect for AI assistance
Super Z (z.ai) multimodal capabilities using `z-ai-web-dev-sdk`:
## 🚀 Quick Start
| Skill | Description |
|-------|-------------|
| ASR | Speech-to-text transcription |
| TTS | Text-to-speech synthesis |
| VLM | Vision language model |
| Image Generation | AI image creation |
| Video Generation | AI video creation |
| PDF/DOCX/XLSX/PPTX | Document processing |
| Web Search | Real-time web search |
| Podcast | Podcast generation |
**Auto-Triggers:** ASR, TTS, image/video generation, PDF/DOCX, multimodal
### 3. Z.AI Tooling Reference (`skills/zai-tooling-reference/`)
Production-ready Next.js 16 patterns:
| Technology | Version |
|------------|---------|
| Next.js | 16.1.1 |
| React | 19 |
| TypeScript | 5 |
| Tailwind CSS | 4 |
| shadcn/ui | 50+ components |
| Prisma | Latest |
| SQLite | Built-in |
| Zustand | State management |
| TanStack Query | Data fetching |
**Auto-Triggers:** Next.js, shadcn/ui, Prisma, WebSocket, React 19
### 4. AI Platforms Consolidated (`skills/ai-platforms-consolidated/`)
Cross-platform comparison and quick reference.
---
## Technology Stack (Root Project)
### Core Framework
- **Next.js 16** - App Router
- **React 19** - Latest React
- **TypeScript 5** - Type safety
- **Tailwind CSS 4** - Styling
### UI Components
- **shadcn/ui** - 50+ components
- **Lucide React** - Icons
- **Framer Motion** - Animations
### State & Data
- **Zustand** - State management
- **TanStack Query** - Data fetching
- **Prisma** - ORM
- **SQLite** - Database
### Forms & Validation
- **React Hook Form** - Forms
- **Zod** - Schema validation
### Auth & Backend
- **NextAuth.js** - Authentication
---
## Quick Start
```bash
# Install dependencies
@@ -63,79 +127,106 @@ bun install
# Start development server
bun run dev
# Database operations
bun run db:push # Push schema changes
bun run db:generate # Generate Prisma client
# Build for production
bun run build
# Start production server
bun start
```
Open [http://localhost:3000](http://localhost:3000) to see your application running.
## 🤖 Powered by Z.ai
This scaffold is optimized for use with [Z.ai](https://chat.z.ai) - your AI assistant for:
- **💻 Code Generation** - Generate components, pages, and features instantly
- **🎨 UI Development** - Create beautiful interfaces with AI assistance
- **🔧 Bug Fixing** - Identify and resolve issues with intelligent suggestions
- **📝 Documentation** - Auto-generate comprehensive documentation
- **🚀 Optimization** - Performance improvements and best practices
Ready to build something amazing? Start chatting with Z.ai at [chat.z.ai](https://chat.z.ai) and experience the future of AI-powered development!
## 📁 Project Structure
```
src/
├── app/ # Next.js App Router pages
├── components/ # Reusable React components
│ └── ui/ # shadcn/ui components
├── hooks/ # Custom React hooks
└── lib/ # Utility functions and configurations
```
## 🎨 Available Features & Components
This scaffold includes a comprehensive set of modern web development tools:
### 🧩 UI Components (shadcn/ui)
- **Layout**: Card, Separator, Aspect Ratio, Resizable Panels
- **Forms**: Input, Textarea, Select, Checkbox, Radio Group, Switch
- **Feedback**: Alert, Toast (Sonner), Progress, Skeleton
- **Navigation**: Breadcrumb, Menubar, Navigation Menu, Pagination
- **Overlay**: Dialog, Sheet, Popover, Tooltip, Hover Card
- **Data Display**: Badge, Avatar, Calendar
### 📊 Advanced Data Features
- **Tables**: Powerful data tables with sorting, filtering, pagination (TanStack Table)
- **Charts**: Beautiful visualizations with Recharts
- **Forms**: Type-safe forms with React Hook Form + Zod validation
### 🎨 Interactive Features
- **Animations**: Smooth micro-interactions with Framer Motion
- **Drag & Drop**: Modern drag-and-drop functionality with DND Kit
- **Theme Switching**: Built-in dark/light mode support
### 🔐 Backend Integration
- **Authentication**: Ready-to-use auth flows with NextAuth.js
- **Database**: Type-safe database operations with Prisma
- **API Client**: HTTP requests with Fetch + TanStack Query
- **State Management**: Simple and scalable with Zustand
### 🌍 Production Features
- **Internationalization**: Multi-language support with Next Intl
- **Image Optimization**: Automatic image processing with Sharp
- **Type Safety**: End-to-end TypeScript with Zod validation
- **Essential Hooks**: 100+ useful React hooks with ReactUse for common patterns
## 🤝 Get Started with Z.ai
1. **Clone this scaffold** to jumpstart your project
2. **Visit [chat.z.ai](https://chat.z.ai)** to access your AI coding assistant
3. **Start building** with intelligent code generation and assistance
4. **Deploy with confidence** using the production-ready setup
Open [http://localhost:3000](http://localhost:3000).
---
Built with ❤️ for the developer community. Supercharged by [Z.ai](https://chat.z.ai) 🚀
## Installation for Claude Code
Copy skills to your Claude Code skills directory:
```bash
# Copy all skills
cp -r skills/* ~/.claude/skills/
# Or copy individually
cp -r skills/minimax-experts ~/.claude/skills/
cp -r skills/glm-skills ~/.claude/skills/
cp -r skills/zai-tooling-reference ~/.claude/skills/
cp -r skills/ai-platforms-consolidated ~/.claude/skills/
```
---
## SDK Quick Reference
### z-ai-web-dev-sdk
```javascript
import ZAI from 'z-ai-web-dev-sdk';
const zai = await ZAI.create();
// LLM Chat
const completion = await zai.chat.completions.create({
messages: [
{ role: 'system', content: 'You are helpful.' },
{ role: 'user', content: 'Hello\!' }
]
});
// Image Generation
const image = await zai.images.generations.create({
prompt: 'A sunset over mountains',
size: '1024x1024'
});
// Web Search
const results = await zai.functions.invoke("web_search", {
query: "latest AI news",
num: 10
});
```
---
## Auto-Trigger Configuration
All skills include auto-trigger capabilities:
| User Says | Skill Triggered |
|-----------|-----------------|
| "I need a landing page" | `minimax-experts` |
| "How do I use speech-to-text?" | `glm-skills` |
| "Set up Prisma with Next.js" | `zai-tooling-reference` |
| "Compare MiniMax vs Super Z" | `ai-platforms-consolidated` |
---
## Sources
| Source | Platform | URL |
|--------|----------|-----|
| MiniMax Experts | MiniMax Agent | https://agent.minimax.io/experts |
| GLM Skills | Super Z (z.ai) | Internal platform |
| Z.AI Tooling | z.ai Development | Internal platform |
---
## Update History
| Date | Changes |
|------|---------|
| 2026-02-13 | Merged original z.ai project with skills, agents, and documentation |
---
## Quick Links
- **MiniMax Platform**: https://agent.minimax.io
- **z-ai-web-dev-sdk**: npm/bun
- **shadcn/ui**: https://ui.shadcn.com
- **Next.js**: https://nextjs.org
- **Prisma**: https://prisma.io
---
*Updated: 2026-02-13*