mirror of
https://github.com/tradecatlabs/vibe-coding-cn.git
synced 2026-08-17 12:58:07 +00:00
tukuaiai
e239f9e4b8
主要变更：
1. **目录重命名**:
* 将 下的 , , 重命名为中文的 , , 。
2. **新增新手入门**:
* 创建 目录，为新用户提供入门指南。
3. **文件迁移与清理**:
* 将原有文档迁移到新的中文目录结构下。
* 删除了部分过时或重复的中文文档。
4. **链接与脚本同步**:
* 更新了根 , 以及 中所有指向旧路径的链接。
* 修改了 下的英文文档，以反映中文文档的结构变化。
* 更新了 翻译脚本，使其能够处理新的中文路径。
此次重构统一了中文文档的目录命名，使其更符合中文用户的习惯，并优化了整体文档的组织结构，提升了可维护性。
3.1 KiB
3.1 KiB
General Project Architecture Template
1️⃣ Standard Structure for Python Web/API Projects
ProjectName/
├── README.md # Project description document
├── LICENSE # Open-source license
├── requirements.txt # Dependency management (pip)
├── pyproject.toml # Modern Python project configuration (recommended)
├── setup.py # Package installation script (if used as a library)
├── .gitignore # Git ignore file
├── .env # Environment variables (not committed to Git)
├── .env.example # Example environment variables
├── CLAUDE.md # Claude persistent context
├── AGENTS.md # Codex persistent context
├── Sublime-Text.txt # For demands and notes, for myself, and CLI session recovery commands ^_^
│
├── docs/ # Documentation directory
│ ├── api.md # API documentation
│ ├── development.md # Development guide
│ └── architecture.md # Architecture description
│
├── scripts/ # Script tools
│ ├── deploy.sh # Deployment script
│ ├── backup.sh # Backup script
│ └── init_db.sh # Database initialization
│
├── tests/ # Test code
│ ├── __init__.py
│ ├── conftest.py # Pytest configuration
│ ├── unit/ # Unit tests
│ ├── integration/ # Integration tests
│ └── test_config.py # Configuration tests
│
├── src/ # Source code (recommended)
│ ├── __init__.py
│ ├── main.py # Program entry point
│ ├── app.py # Flask/FastAPI application
│ ├── config.py # Configuration management
│ │
│ ├── core/ # Core business logic
│ │ ├── __init__.py
│ │ ├── models/ # Data models
│ │ ├── services/ # Business services
│ │ └── utils/ # Utility functions
│ │
│ ├── api/ # API interface layer
│ │ ├── __init__.py
│ │ ├── v1/ # Version 1
│ │ └── dependencies.py
│ │
│ ├── data/ # Data processing
│ │ ├── __init__.py
│ │ ├── repository/ # Data access layer
│ │ └── migrations/ # Database migrations
│ │
│ └── external/ # External services
│ ├── __init__.py
│ ├── clients/ # API clients
│ └── integrations/ # Integration services
│
├── logs/ # Log directory (not committed to Git)
│ ├── app.log
│ └── error.log
│
└── data/ # Data directory (not committed to Git)
├── raw/ # Raw data
├── processed/ # Processed data
└── cache/ # Cache