We0 项目安装与使用教程
1. 项目的目录结构及介绍
We0 是一个为开发程序员和产品经理设计的 AI 代码编辑器。项目的主要目录结构如下:
we0/
├── apps/ # 应用目录,包含客户端和服务端应用
│ ├── we-dev-client/ # 客户端应用
│ └── we-dev-next/ # 服务端应用
├── scripts/ # 脚本目录,包含构建和启动脚本
├── .gitignore # Git 忽略文件
├── .npmrc # npm 配置文件
├── Dockerfile # Docker 配置文件
├── LICENSE # 许可证文件
├── README.md # 项目说明文件
├── package-lock.json # 包锁文件
├── package.json # 包配置文件
└── tsconfig.json # TypeScript 配置文件
2. 项目的启动文件介绍
项目的启动主要涉及两个应用:客户端和服务端。
客户端启动
客户端应用的启动文件位于 apps/we-dev-client
目录中。可以通过以下命令启动:
cd apps/we-dev-client
pnpm dev
服务端启动
服务端应用的启动文件位于 apps/we-dev-next
目录中。可以通过以下命令启动:
cd apps/we-dev-next
pnpm dev
3. 项目的配置文件介绍
项目的配置文件主要有两个:.env.example
和 .env
。
.env.example
.env.example
文件是配置文件的示例,包含了所有需要配置的环境变量以及它们的默认值或示例值。在正式使用时,需要将 .env.example
文件重命名为 .env
并填入实际配置。
客户端的 .env.example
可能包含以下内容:
# SERVER_ADDRESS [MUST*] (eg: http://localhost:3000)
APP_BASE_URL=
# JWT_SECRET [Optional]
JWT_SECRET=
服务端的 .env.example
可能包含以下内容:
# Third-Party Model URL [MUST*] (eg: https://api.openai.com/v1)
THIRD_API_URL=
# Third-Party Model API-Key [MUST*] (eg:sk-xxxx)
THIRD_API_KEY=
# JWT_SECRET [Optional]
JWT_SECRET=
.env
.env
文件是实际使用的配置文件,其中包含了项目运行所必需的环境变量值。开发者需要根据实际情况填写或生成这些值。例如:
APP_BASE_URL=http://localhost:3000
JWT_SECRET=your_secret_key
THIRD_API_URL=https://api.openai.com/v1
THIRD_API_KEY=your_api_key
JWT_SECRET=your_secret_key
确保正确配置 .env
文件,以避免运行时出现配置错误。
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考