首页
/ 一、项目的目录结构及介绍

一、项目的目录结构及介绍

2025-04-18 01:33:14作者:伍希望

oneShotCodeGen 是一个开源项目,用于生成全栈应用程序。以下是项目的目录结构及各部分的功能介绍:

app-generator-cli/
├── src/                       # 源代码目录,包含命令行界面(CLI)的代码
├── output/                    # 生成的应用程序目录,每个应用程序都有一个基于时间戳的子目录
│   └── [timestamp]/
│       ├── frontend/           # React前端应用程序
│       ├── use_cases.json      # 使用案例定义
│       ├── entities.json       # 实体模型
│       ├── mock_users.json     # 模拟用户数据
│       ├── mock_data.json      # 生成的测试数据
│       └── domain_model.j      # 域模型(文件名不完整,可能是示例)
├── .gitignore                 # 指定Git应忽略的文件和目录
├── LICENSE                    # 项目许可证文件
├── base.Dockerfile            # 用于构建基础镜像的Dockerfile
├── readme.md                  # 项目自述文件
├── requirements.txt           # 项目依赖文件
└── setup.py                   # 设置文件,用于安装Python包

二、项目的启动文件介绍

项目的启动主要是通过 src 目录中的命令行界面(CLI)脚本实现的。以下是主要启动文件及其功能:

  • src/cli.py: 这是主要的命令行界面脚本,用户可以通过它来创建或编辑应用程序。
  • src/app_generator.py: 这个脚本包含了生成应用程序的主要逻辑。

要生成一个新的应用程序,用户可以使用以下命令:

python -m src.cli create "Create an expense tracker app"

三、项目的配置文件介绍

项目的配置主要通过环境变量和配置文件来管理。以下是一些关键的配置:

  • /.env: 环境变量文件,用于存储API密钥、Supabase项目URL、匿名密钥和其他敏感信息。
  • nginx.conf: 如果使用Nginx作为反向代理,此文件将用于配置Nginx。

以下是 .env 文件的一个示例:

OPENAI_API_KEY=your_openai_api_key
SUPABASE_PROJECT_URL=your_supabase_url
SUPABASE_ANON_KEY=your_supabase_anon_key
SUPABASE_DB_PASSWORD=your_db_password

确保在运行项目之前设置好这些配置项。

登录后查看全文
热门项目推荐