Dara 项目使用教程
1. 项目目录结构及介绍
Dara 项目的目录结构如下:
dara/
├── docs/
│ └── img/
├── packages/
│ ├── dara-core/
│ ├── dara-components/
│ └── create-dara-app/
├── tooling/
├── .gitignore
├── .npmrc
├── CONTRIBUTING.md
├── LICENSE
├── Makefile
├── README.md
├── anthology.toml
├── bearer.yml
├── lerna.json
├── package.json
├── pnpm-lock.yaml
├── pnpm-workspace.yaml
├── poetry.lock
├── poetry.toml
├── pyproject.toml
└── tsconfig.json
目录结构介绍
- docs/: 包含项目文档和相关图片资源。
- packages/: 包含 Dara 项目的主要包,包括
dara-core
(核心框架代码)、dara-components
(组件库)和create-dara-app
(CLI 工具)。 - tooling/: 包含项目构建和开发工具的相关配置和脚本。
- .gitignore: Git 忽略文件配置。
- .npmrc: npm 配置文件。
- CONTRIBUTING.md: 贡献指南。
- LICENSE: 项目许可证(Apache 2.0)。
- Makefile: 项目构建和任务管理文件。
- README.md: 项目介绍和使用说明。
- anthology.toml: 项目配置文件。
- bearer.yml: 项目配置文件。
- lerna.json: Lerna 多包管理工具配置文件。
- package.json: npm 包管理文件。
- pnpm-lock.yaml: pnpm 锁定文件。
- pnpm-workspace.yaml: pnpm 工作区配置文件。
- poetry.lock: Poetry 依赖锁定文件。
- poetry.toml: Poetry 配置文件。
- pyproject.toml: Python 项目配置文件。
- tsconfig.json: TypeScript 配置文件。
2. 项目启动文件介绍
Dara 项目的启动文件主要依赖于 create-dara-app
CLI 工具。以下是启动项目的步骤:
-
安装 CLI 工具:
pip install create-dara-app
-
创建新项目:
create-dara-app
-
启动项目:
- 使用 Poetry 安装时:
cd my-dara-app poetry run dara start
- 使用 pip 安装时:
cd my-dara-app source venv/bin/activate dara start
- 使用 Poetry 安装时:
3. 项目配置文件介绍
Dara 项目的配置文件主要包括以下几个:
- pyproject.toml: Python 项目的主要配置文件,包含项目依赖、构建工具配置等信息。
- poetry.toml: Poetry 工具的配置文件,用于管理 Python 包的依赖和环境。
- tsconfig.json: TypeScript 项目的配置文件,定义 TypeScript 编译选项。
- lerna.json: Lerna 多包管理工具的配置文件,用于管理多个 npm 包的版本和发布。
- pnpm-workspace.yaml: pnpm 工作区配置文件,用于管理多个 npm 包的工作区。
- Makefile: 项目构建和任务管理的配置文件,包含各种构建和测试任务的定义。
这些配置文件共同协作,确保 Dara 项目能够顺利构建、运行和发布。