Oasis Wallet Web 开源项目快速入门指南
1. 项目目录结构及介绍
Oasis Wallet Web 是一个非托管式的钱包应用,专为 Oasis Network 设计。以下是其主要的目录结构及其简介:
android
: Android 应用相关的代码和资源。assets
: 静态资产,如图片、图标等。cypress
: E2E 测试套件,使用 Cypress 框架。docker
: Docker 相关配置,用于本地开发环境的快速搭建。docs
: 文档资料,可能包括开发指引或架构概述。extension/src
: 浏览器扩展程序的主要源码所在。internals
: 内部工具或脚本,不直接参与前端构建。.gitattributes
,.gitignore
,.npmrc
: 版本控制和构建配置相关文件。ios
: iOS 应用的相关代码和资源。playwright
: UI 测试框架 Playwright 的测试脚本存放位置。public
: 可直接被 Web 服务器服务的静态文件,如 HTML 入口文件。src
: 主要的前端源代码,包括 React 组件和其他业务逻辑。src/babelrc
,eslintignore
,eslintrc.js
: 代码风格配置。src/index.js
或其他入口文件,是应用启动的起点。
scripts
: 构建、部署和测试等相关脚本。test
,__tests__
: 单元测试文件夹。README.md
,LICENSE
,CHANGES.md
: 项目说明、许可协议和变更日志。
2. 项目的启动文件介绍
在 Oasis Wallet Web 中,启动流程通常通过脚本来管理,而不是直接指定某个启动文件。开发者通常运行以下命令来启动项目:
yarn install
yarn start
这里的 start
脚本通常是位于 package.json
文件中定义的,它会启动开发服务器,允许开发者实时查看应用的变化。
对于本地网络调试,还可以使用:
docker-compose up --build -d
REACT_APP_LOCALNET=1 yarn start
这将先启动必要的后端服务,然后以适应本地网络的方式启动前端应用。
3. 项目的配置文件介绍
主要配置文件
.env
和.env.production
: 环境变量配置,分别对应开发和生产环境。可以设置如 API 地址、环境标志等。package.json
: 包含了项目的依赖信息、脚本命令、版本号等关键数据。Renovate.json
: 自动化依赖更新配置。tsconfig.json
: TypeScript 编译配置文件,影响TypeScript如何编译到JavaScript。
特殊配置
capacitor.config.ts
: 如果涉及移动应用部分,这是Capacitor的配置文件。docker-compose.yml
: 定义了本地开发所需的Docker容器和服务。jest.config.js
,cypress.json
: 分别为Jest单元测试和Cypress E2E测试的配置文件。playwright.config.js
: Playwright UI测试的配置。
确保在修改任何配置之前阅读相应的官方文档或者项目内的注释,以便正确理解和应用这些配置。