Buildware AI 项目使用教程

Buildware AI 项目使用教程

buildware-ai An experimental AI coding tool. 项目地址: https://gitcode.com/gh_mirrors/bu/buildware-ai

1. 项目目录结构及介绍

Buildware AI 的目录结构如下：

.
├── .github
├── .husky
├── actions
├── app
│   ├── components
│   ├── db
│   ├── lib
│   └── public
├── scripts
│   └── webhook-proxy
├── types
├── .env.example
├── .eslintrc.json
├── .gitignore
├── README.md
├── components.json
├── drizzle.config.ts
├── license
├── middleware.ts
├── next.config.mjs
├── package-lock.json
├── package.json
├── postcss.config.mjs
├── prettier.config.cjs
├── tailwind.config.ts
└── tsconfig.json

• .github: 存放 GitHub Actions 相关的工作流文件。
• .husky: 用于配置 Husky，一个用于管理 Git 钩子的工具。
• actions: 包含项目中的自动化动作脚本。
• app: 主应用目录，包含组件、数据库、库和公共资源。
• scripts: 包含项目脚本，例如 webhook 代理。
• types: TypeScript 类型定义文件。
• .env.example: 环境变量示例文件。
• .eslintrc.json: ESLint 配置文件。
• .gitignore: Git 忽略文件列表。
• README.md: 项目说明文件。
• components.json: 组件配置文件。
• drizzle.config.ts: Drizzle 配置文件，用于数据库操作。
• license: 项目许可证文件。
• middleware.ts: 中间件配置文件。
• next.config.mjs: Next.js 配置文件。
• package-lock.json: npm 包锁定文件。
• package.json: npm 包配置文件。
• postcss.config.mjs: PostCSS 配置文件。
• prettier.config.cjs: Prettier 配置文件。
• tailwind.config.ts: Tailwind CSS 配置文件。
• tsconfig.json: TypeScript 配置文件。

2. 项目的启动文件介绍

项目的启动主要通过 package.json 中的脚本实现。以下是一些主要的启动脚本：

• npm run dev: 启动开发服务器。
• npm run build: 构建应用的生产版本。
• npm run migrate: 运行数据库迁移。

3. 项目的配置文件介绍

项目的配置主要通过以下几个文件进行：

• .env.example: 包含了项目所需的环境变量的示例，需要复制为 .env.local 文件并根据实际情况进行填写。
• next.config.mjs: Next.js 的配置文件，用于自定义 Web 应用的设置。
• drizzle.config.ts: Drizzle 的配置文件，用于配置数据库连接和模型。
• tailwind.config.ts: Tailwind CSS 的配置文件，用于定制化 CSS 样式。

在开始使用前，需要确保正确配置了所有必要的环境变量，并且按照官方教程完成了数据库和 GitHub PAT 的设置。

buildware-ai An experimental AI coding tool. 项目地址: https://gitcode.com/gh_mirrors/bu/buildware-ai