|
1 | 1 | # 12Factor.me |
2 | 2 |
|
| 3 | +[中文版](#中文版) | English |
| 4 | + |
3 | 5 | <div align="center"> |
4 | | - <div style="width: 32px; height: 32px; background-color: #1c1917; border-radius: 8px; display: inline-flex; align-items: center; justify-content: center; margin-bottom: 16px;"> |
5 | | - <div style="width: 16px; height: 16px; border: 2px solid white; border-radius: 2px;"></div> |
6 | | - </div> |
7 | | - <h3>12 Vibe Coding Factors</h3> |
8 | | - <p><strong>Four-Stage Twelve-Principle methodology for 10x Engineering Efficiency</strong></p> |
9 | | - <p>Visit: <a href="https://12factor.me">https://12factor.me</a></p> |
| 6 | + <h3>🎯 12Factor Methodology</h3> |
| 7 | + <p><strong>Master AI-Human Collaboration for 10x Engineering Efficiency</strong></p> |
| 8 | + <p><a href="https://12factor.me">12factor.me</a> | <a href="https://github.com/wquguru/12factor">GitHub</a></p> |
10 | 9 |
|
11 | 10 | [](https://github.com/wquguru/12factor/actions/workflows/build.yml) |
12 | 11 | </div> |
13 | 12 |
|
14 | 13 | ## Overview |
15 | 14 |
|
16 | | -12Factor provides real methodological insights for mastering AI-human collaboration, without the complexity overload. The platform teaches 12 essential principles through an interactive, gamified learning experience with bilingual support. |
17 | | - |
18 | | -**Four-Stage Learning Path:** |
19 | | - |
20 | | -1. **Prepare** - Single Source of Truth, Prompt First, Context Hygiene |
21 | | -2. **Execute** - Human-in-the-Loop, Chunked Work, Parallel Flow |
22 | | -3. **Collaborate** - Cognitive Load Budget, Flow Protection, Reproducible Sessions |
23 | | -4. **Iterate** - Rest & Reflection, Skill Parity, Culture of Curiosity |
| 15 | +Interactive learning platform teaching the Four-Stage Twelve-Principle methodology for AI collaboration era. Features gamified lessons, prompt engineering playground, and bilingual support. |
24 | 16 |
|
25 | 17 | ## Quick Start |
26 | 18 |
|
27 | 19 | ```bash |
28 | 20 | npm install |
29 | 21 | npm run dev # Start at http://localhost:3000 |
30 | 22 | npm run build # Production build |
31 | | -npm run lint # Code quality checks |
32 | 23 | ``` |
33 | 24 |
|
34 | | -## Key Features |
35 | | - |
36 | | -- **Bilingual Learning**: Full English and Chinese localization |
37 | | -- **Interactive Content**: Flashcards with progress tracking |
38 | | -- **Adaptive Quizzes**: Multiple difficulty modes with performance analytics |
39 | | -- **10x Engineering Focus**: Systematic approach to AI collaboration efficiency |
40 | | -- **Open Source**: MIT licensed, community-driven development |
41 | | - |
42 | | -## LLM API Configuration |
43 | | - |
44 | | -The prompt engineering features support custom LLM providers. Configure your API in `.env.local`: |
| 25 | +### Prompt Engineering Setup (Optional) |
45 | 26 |
|
46 | 27 | ```bash |
47 | | -# Copy environment template |
48 | 28 | cp .env.example .env.local |
| 29 | +# Add your API key (OpenAI/DeepSeek/Azure) |
49 | 30 | ``` |
50 | 31 |
|
51 | | -### Using DeepSeek (Recommended) |
52 | | -```env |
53 | | -OPENAI_API_KEY=sk-your-deepseek-key |
54 | | -LLM_API_URL=https://api.deepseek.com/v1/chat/completions |
55 | | -LLM_MODEL=deepseek-chat |
56 | | -``` |
| 32 | +## Learning Paths |
| 33 | + |
| 34 | +### 🎓 12 Principles Course |
| 35 | +**Four Stages:** Prepare → Execute → Collaborate → Iterate |
| 36 | +- Interactive flashcards with progress tracking |
| 37 | +- Adaptive quizzes with performance analytics |
| 38 | +- Real-world examples and anti-patterns |
| 39 | + |
| 40 | +### 🤖 Prompt Engineering Lab |
| 41 | +**Three Learning Modes:** |
| 42 | +- **Theory**: Core concepts and techniques |
| 43 | +- **Practice**: Guided exercises with hints |
| 44 | +- **Playground**: Live LLM experimentation |
| 45 | + |
| 46 | +**Course Topics:** |
| 47 | +- Fundamentals: Structure, system prompts, role assignment |
| 48 | +- Advanced: Few-shot, chain-of-thought, temperature control |
| 49 | +- Optimization: Token efficiency, context management |
| 50 | + |
| 51 | +## Features |
| 52 | + |
| 53 | +- ✅ Bilingual (English/中文) |
| 54 | +- ✅ Dark mode support |
| 55 | +- ✅ Progress persistence |
| 56 | +- ✅ Multi-LLM support (OpenAI, DeepSeek, Azure) |
| 57 | +- ✅ Rate-limited API with security |
| 58 | +- ✅ Mobile responsive |
| 59 | + |
| 60 | +## Tech Stack |
| 61 | + |
| 62 | +Next.js 15 • TypeScript • Tailwind CSS • Zustand • next-intl |
| 63 | + |
| 64 | +--- |
| 65 | + |
| 66 | +# 中文版 |
57 | 67 |
|
58 | | -### Using OpenAI (Default) |
59 | | -```env |
60 | | -OPENAI_API_KEY=sk-your-openai-key |
| 68 | +[English](#12factorme) | 中文版 |
| 69 | + |
| 70 | +<div align="center"> |
| 71 | + <h3>🎯 12Factor 方法论</h3> |
| 72 | + <p><strong>掌握AI协作,实现10倍工程效率</strong></p> |
| 73 | + <p><a href="https://12factor.me">12factor.me</a> | <a href="https://github.com/wquguru/12factor">GitHub</a></p> |
| 74 | +</div> |
| 75 | + |
| 76 | +## 概述 |
| 77 | + |
| 78 | +互动学习平台,教授AI协作时代的四阶段十二原则方法论。包含游戏化课程、提示工程实验室和双语支持。 |
| 79 | + |
| 80 | +## 快速开始 |
| 81 | + |
| 82 | +```bash |
| 83 | +npm install |
| 84 | +npm run dev # 启动开发服务器 http://localhost:3000 |
| 85 | +npm run build # 生产构建 |
61 | 86 | ``` |
62 | 87 |
|
63 | | -### Health Check |
| 88 | +### 提示工程配置(可选) |
| 89 | + |
64 | 90 | ```bash |
65 | | -curl http://localhost:3000/api/llm/health |
| 91 | +cp .env.example .env.local |
| 92 | +# 添加您的API密钥(OpenAI/DeepSeek/Azure) |
66 | 93 | ``` |
67 | 94 |
|
68 | | -> See [LLM_API_SETUP.md](./LLM_API_SETUP.md) for more configuration options. |
| 95 | +## 学习路径 |
| 96 | + |
| 97 | +### 🎓 十二原则课程 |
| 98 | +**四个阶段:** 准备 → 执行 → 协作 → 迭代 |
| 99 | +- 互动闪卡与进度追踪 |
| 100 | +- 自适应测验与性能分析 |
| 101 | +- 真实案例与反模式 |
| 102 | + |
| 103 | +### 🤖 提示工程实验室 |
| 104 | +**三种学习模式:** |
| 105 | +- **理论**:核心概念与技术 |
| 106 | +- **练习**:带提示的引导练习 |
| 107 | +- **实验室**:实时LLM实验 |
| 108 | + |
| 109 | +**课程主题:** |
| 110 | +- 基础:结构、系统提示、角色分配 |
| 111 | +- 进阶:少样本学习、思维链、温度控制 |
| 112 | +- 优化:令牌效率、上下文管理 |
| 113 | + |
| 114 | +## 功能特性 |
| 115 | + |
| 116 | +- ✅ 双语支持(中文/English) |
| 117 | +- ✅ 深色模式 |
| 118 | +- ✅ 进度持久化 |
| 119 | +- ✅ 多LLM支持(OpenAI、DeepSeek、Azure) |
| 120 | +- ✅ 限流API与安全保护 |
| 121 | +- ✅ 移动端响应式 |
69 | 122 |
|
70 | | -## Technology Stack |
| 123 | +## 技术栈 |
71 | 124 |
|
72 | | -- **Framework**: Next.js 15 with App Router |
73 | | -- **Language**: TypeScript (strict mode) |
74 | | -- **Styling**: Tailwind CSS with dark mode |
75 | | -- **State**: Zustand for lightweight management |
76 | | -- **i18n**: next-intl for internationalization |
77 | | -- **Icons**: Heroicons for consistent UI |
78 | | -- **LLM**: OpenAI SDK with custom endpoint support |
| 125 | +Next.js 15 • TypeScript • Tailwind CSS • Zustand • next-intl |
0 commit comments