# NeeDo

**Repository Path**: afeng616/needo

## Basic Information

- **Project Name**: NeeDo
- **Description**: 能有一个始终在桌面上或最上级显示的极简 ToDoList。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-09-04
- **Last Updated**: 2023-09-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 项目初始化

基于vue3+typescript+electron+element plus开发桌面应用。  

### 环境准备

windows从零新建一个桌面应用的项目说明，包括各种环境安装。

1. 安装npm  
- npm的安装可以直接使用官方的.exe文件[^1]。  
- 当然也可以使用nvm[^2]进行安装，相比起来更方便，还可以进行npm的版本管理。  

  nvm安装完毕以后，打开命令行，安装node版本V16（V18版本在安装electron时会有openssl-legacy-provider问题，比较难解决）。
  ```shell
  nvm install 16
  nvm use 16
  ```

2. 安装vue-cli  
   ```shell
   npm install -g @vue/cli
   ```

3. 安装electron  
   ```shell
   npm install electron --save-dev
   ```
   安装过程中可能会遇到下载失败的问题[^3]，解决方法如下：
   ```
   npm config edit
   ```
   修改`.npmrc`文件配置并保存。
   ```
   registry=https://registry.npmmirror.com
   electron_mirror=https://cdn.npmmirror.com/binaries/electron/
   electron_builder_binaries_mirror=https://npmmirror.com/mirrors/electron-builder-binaries/
   ```

### 新建架构

vue3+typescript+electron+element plus
vue3+electron环境初始化[^4]步骤如下：

```shell
vue create myproject
cd myproject

vue add electron-builder
npm install ts-loader@~8.2.0
npm install element-plus --save
```

生成的代码中，DEVTOOLS部分[^5]可能存在问题，需要进行修改。

```shell
# 项目启动
npm run electron:serve
```

## 项目共享

当与他人共享源码时，不需要拷贝`/node_modules`和`/dist_electron`文件夹以及`package-lock.json`文件。  
由于npm环境不同，很可能导致不必要的错误，它们直接由以下命令生成。
```shell
# vue和electron安装完毕后
npm install
```

## References

[^1]: https://nodejs.org/zh-cn/download "nodejs官方下载网址"
[^2]: https://github.com/coreybutler/nvm-windows/releases "nvm-windows下载网址"
[^3]: https://www.cnblogs.com/makalochen/p/16154510.html "cnblog: npm 安装electron 失败的问题和解决办法"
[^4]: https://segmentfault.com/a/1190000038463122 "segmentfault: Vue+Electron项目简洁快速搭建教程"
[^5]: https://stackoverflow.com/a/67378046/14065254 "stackoverflow: DevTools加载问题"
>>>>>>> master/master