name: 创建项目 description: 为 Algorand 去中心化应用和智能合约引导生产就绪的 AlgoKit 项目。在初始化新的 Algorand 智能合约项目、从头设置开发环境或使用预配置工具搭建 dApp 时使用。强烈触发词包括“创建新项目”、“初始化新的 Algorand 应用”、“启动新的智能合约”、“设置 AlgoKit”、“搭建 dApp”、“algokit init”。
AlgoKit 项目初始化
使用 AlgoKit 官方模板创建新的 Algorand 项目。
概述 / 核心工作流
- 与用户确认项目详情(名称、模板、自定义项)
- 使用适当的标志运行
algokit init - 处理任何初始化错误
- 提供构建/测试的后续步骤
如何操作
-
与用户确认项目详情:
- 项目名称(目录名)
- 模板选择(TypeScript 或 Python)
- 任何自定义项(
--no-git、--no-bootstrap、作者姓名) - 对于 TypeScript:为生产项目确认生产预设
-
运行初始化命令:
TypeScript(生产预设):
algokit init -n <项目名称> -t typescript --answer preset_name production --answer author_name "<姓名>" --defaultsTypeScript(入门预设):
algokit init -n <项目名称> -t typescript --answer author_name "<姓名>" --defaultsPython(生产预设):
algokit init -n <项目名称> -t python --answer preset_name production --answer author_name "<姓名>" --defaultsPython(入门预设):
algokit init -n <项目名称> -t python --answer author_name "<姓名>" --defaults使用自定义选项(无 git,无引导):
algokit init -n <项目名称> -t typescript --no-git --no-bootstrap --defaults -
处理错误:
- 检查项目目录是否已存在
- 验证 AlgoKit 是否已安装:
algokit --version - 确保目标目录可写
- 有效模板:
typescript、python、tealscript、react、fullstack、base
-
提供后续步骤:
cd <项目名称>algokit project run build— 编译合约algokit project run test— 运行测试套件algokit localnet start— 启动本地网络(如果部署)algokit project run deploy— 将合约部署到本地网络
重要规则 / 指南
- 执行前始终与用户确认 — 未经明确确认,切勿运行
algokit init - 默认使用 TypeScript — 推荐用于生产应用
- 使用生产预设 — 适用于任何项目,因为它包含测试框架和部署脚本
- 包含作者姓名 — 传递
--answer author_name "<姓名>"以进行归属 - 使用
--defaults— 接受所有其他默认值以进入非交互模式
常见变体 / 边缘情况
| 场景 | 方法 |
|---|---|
| 使用 TypeScript 部署的 Python | --answer deployment_language "typescript" |
| 现有目录 | 检查并警告目录是否已存在 |
| 无 Git 初始化 | 使用 --no-git 标志 |
| 无依赖项安装 | 使用 --no-bootstrap 标志 |
| 自定义作者姓名 | --answer author_name "您的姓名" |
| 全栈(前端 + 合约) | 使用 -t fullstack 模板 |
| 仅 React 前端 | 使用 -t react 模板 |
| 独立(无工作区) | 使用 --no-workspace 标志 |
| 从示例初始化 | 使用 algokit init example 子命令 |