# electron-egg
一个快速、功能丰富的桌面软件开发框架，基于electron和egg.js

[官网: http://b.kaka996.com/](http://b.kaka996.com/#/feed)

[文档迁移到了羽雀](https://www.yuque.com/u34495/mivcfg/xnhmms)

## 特性
1. 直接打包成windows版、Mac版、Linux版或者以web网站运行
2. 可以用服务端的开发思维，来编写桌面软件
3. 也可以用前端来开发，数据服务请求外部api即可
4. 服务端的技术场景几乎都可以使用，如：路由、中间件、控制器、服务、定时任务、队列、插件等
5. 桌面软件常见功能，后续逐步集成并完善或提供demo。

## 开始使用

1. 下载
    ```
    # gitee
    git clone https://gitee.com/wallace5303/electron-egg.git
    # github
    git clone https://github.com/wallace5303/electron-egg.git
    ```

2. 启动
    ```
    # 进入目录 ./electron-egg/
    npm install
    npm run dev
    ```
3. 常用命令
    ```
    # 开发者模式
    npm run dev
    # 生产者模式
    npm run start
    # 打包 （windows版本）
    npm run build-w
    # 打包 （mac版本）
    npm run build-m
    # 打包 （linux版本）
    npm run build-l
    ```

## 项目案例

1. 网址管理大师
![](https://i.loli.net/2020/11/02/ByFDKeY6nmdxGoc.png)
[体验web版本和客户端版](http://b.kaka996.com/)

注：# 联系作者（邮箱：530353222@qq.com）展示你的项目

## 进行中功能
1. 软件自动更新
2. 数据本地存储
3. mac版功能兼容
4. 以web版运行

## 欢迎star