Lisk Desktop 项目安装与使用教程
1. 项目目录结构及介绍
Lisk Desktop 项目的目录结构如下:
├── husky/ # 包含预提交钩子,用于在提交前检查文件是否格式化
├── app/ # Electron 应用程序,启动 React 应用
├── build/ # 构建特定材料
├── coverage/ # Jest 测试覆盖率结果
├── dist/ # 平台特定的构建输出
├── docs/ # 项目文档,如贡献指南和开发指南
├── libs/ # 可单独在其他项目中使用的模块
│ ├── hardwareWallet/ # 硬件钱包集成
│ ├── wcm/ # 钱包连接
├── node_modules/ # 第三方库和工具
├── setup/ # 应用的最顶层,包含 MainRouter 和全局导入的 CSS 文件
│ ├── config/ # 自动化脚本(Webpack 配置、i18n 扫描等)
│ ├── react/ # React 展示组件
│ ├── app/ # 引导 React 应用程序
│ ├── assets/ # 静态文件(图片、字体等)
├── src/ # 应用程序源代码
│ ├── const/ # 静态配置和其他在整个应用程序中使用的值
│ ├── locales/ # 包含构建的本地化文件
│ ├── modules/ # 按领域划分的逻辑,示例结构如下
│ ├── hardwareWallet/ # 模块/领域
│ ├── __fixtures__/ # 硬件钱包模块的模拟数据
│ ├── components/ # 与硬件钱包领域相关的组件
│ ├── hooks/ # 与硬件钱包领域相关的钩子
│ ├── store/ # Redux 封装的硬件钱包领域逻辑
│ ├── actions/ # 硬件钱包动作
│ ├── selectors/ # 硬件钱包选择器
│ ├── reducers/ # 硬件钱包 reducers
│ ├── utils/ # 硬件钱包模块中使用的工具,全局工具应放在 src/utils
│ ├── redux/ # 包含根 reducer,所有其他 reducers 在此导入
│ ├── routes/ # 包含应用程序中的所有路由和模态框
│ ├── routes.js # 路由和模态框路径及其元数据
│ ├── routesMap.js # 将组件映射到路由,用于 MainRouter.js
│ ├── service/ # 添加服务,如模拟服务
│ ├── theme/ # 主题化组件(按钮、输入等)
│ ├── utils/ # 全局实用函数
├── i18n/ # 本地化设置
└── e2e/ # 使用 Playwright 和 Cucumber 编写的 E2E 测试,以及一些单元测试的辅助工具
2. 项目启动文件介绍
Lisk Desktop 项目的启动文件主要包括以下几个部分:
app/
目录:这是 Electron 应用程序的入口,负责启动 React 应用。src/
目录:这是 React 应用的源代码目录,包含了应用的主要逻辑和组件。setup/
目录:包含应用的最顶层配置和全局导入的 CSS 文件。
3. 项目的配置文件介绍
Lisk Desktop 项目的主要配置文件包括:
.eslintrc
:ESLint 配置文件,用于代码风格检查。.prettierrc
:Prettier 配置文件,用于代码格式化。babel.config.js
:Babel 配置文件,用于 JavaScript 代码的转译。webpack.config.js
:Webpack 配置文件,用于打包和构建应用。package.json
:项目的依赖和脚本配置文件。
这些配置文件共同作用,确保项目在开发和构建过程中的一致性和规范性。