Skip to content

Commit 4a71889

Browse files
author
weiwenda
committed
增加开发指南
1 parent a9477ae commit 4a71889

File tree

2 files changed

+44
-0
lines changed

2 files changed

+44
-0
lines changed

Development.md

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
## 编译环境准备
2+
1. 下载node v18.17.1+ [node官网地址](https://nodejs.org/en)
3+
2. 在项目根目录执行
4+
```
5+
npm install --force
6+
```
7+
8+
## 前端调试(src目录下的代码)
9+
1. 启动EffectNote桌面客户端,确保 http://localhost:51223/ 可正常打开
10+
2. 在项目根目录执行
11+
```
12+
npm run startdev
13+
```
14+
3. 浏览器自动跳转 http://localhost:3000/ 即可进行调试
15+
16+
## 后端调试(main目录下的代码)
17+
1. 彻底关闭EffectNote桌面客户端
18+
2. 提前生成前端静态文件
19+
```
20+
npm run build
21+
```
22+
执行成功后,build目录下将有以下内容
23+
![](./docs/build_file_tree.png)
24+
3. 启动electron调试进程
25+
```
26+
npm run start
27+
```
28+
## 生成windows安装包
29+
1. 依次执行以下命令
30+
```
31+
npm run build-win32
32+
del -A ./node_modules/.cache
33+
electron-forge make --platform win32
34+
```
35+
36+
## 生成Mac无签名包
37+
1. 注释forge.config.js的line39~line49
38+
2. 执行编译命令
39+
```
40+
npm run make
41+
```
42+

README.md

+2
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,8 @@ Project Vision:Empower Personal Knowledge Management And Discovery
6666
### 订阅检索
6767
![](./public/images/readme_pic2.png)
6868

69+
## Contributing
70+
- [Development Guide](https://github.com/WeiWenda/effect-note-mobile/blob/main/Development.md)
6971

7072
## Thanks To
7173
- [react](https://github.com/facebook/react)

0 commit comments

Comments
 (0)