Joule Extension 项目教程
1. 项目目录结构及介绍
Joule Extension 项目的目录结构如下:
joule-extension/
├── src/
│ ├── app/
│ │ ├── index.tsx
│ │ ├── AppRoutes.tsx
│ │ ├── PromptRoutes.tsx
│ │ ├── components/
│ │ ├── lib/
│ │ ├── modules/
│ │ ├── pages/
│ ├── ...
├── ...
目录结构介绍
- src/: 项目的源代码目录。
- app/: 包含主要的 React 应用代码。
- index.tsx: 应用的入口文件。
- AppRoutes.tsx: 在弹出窗口和选项客户端中使用的路由。
- PromptRoutes.tsx: 在提示客户端中使用的路由。
- components/: 包含所有可重用的组件。
- lib/: 包含独立的库,可能会拆分为节点模块。
- modules/: 包含业务逻辑的垂直切片,主要是 Redux 代码。
- pages/: 包含应用路由的容器组件。
- app/: 包含主要的 React 应用代码。
2. 项目的启动文件介绍
项目的启动文件是 src/app/index.tsx
。这个文件是整个应用的入口点,负责初始化应用并加载必要的组件和路由。
index.tsx
文件介绍
// src/app/index.tsx
import React from 'react';
import ReactDOM from 'react-dom';
import App from './App';
ReactDOM.render(<App />, document.getElementById('root'));
- ReactDOM.render: 将
App
组件渲染到root
元素中,启动整个应用。
3. 项目的配置文件介绍
Joule Extension 项目没有明确的配置文件,但可以通过以下方式进行配置:
配置方式
- 环境变量: 可以通过设置环境变量来配置应用的行为。
- Macaroon 文件: 需要提供 Macaroon 文件来连接到 Lightning 节点。
配置示例
# 设置环境变量
export NODE_ENV=development
# 提供 Macaroon 文件路径
export MACAROON_PATH=/path/to/macaroon/file
通过以上配置,可以启动并运行 Joule Extension 项目。