# electron-prokit

**Repository Path**: chunsuo/electron-prokit

## Basic Information

- **Project Name**: electron-prokit
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-12-08
- **Last Updated**: 2024-12-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<div align="center">
  <p align="center">
    <img style="width:300px" src="https://github.com/Xutaotaotao/electron-prokit/blob/main/docs/public/logo.svg" alt="logo">
  </p>
  <h1>Electron Prokit</h1>
  <p>一款基于 Electron 的桌面软件开发框架,让你拥有极致的桌面开发体验。</p>

  <p align="center">
    <a href="https://npmjs.com/package/electron-prokit"><img src="https://img.shields.io/npm/v/electron-prokit.svg" alt="npm package"></a>
    <a href="https://nodejs.org/en/about/releases/"><img src="https://img.shields.io/node/v/electron-prokit.svg" alt="node compatibility"></a>
    <a href="https://github.com/Xutaotaotao/electron-prokit/actions/workflows/release.yml"><img src="https://github.com/Xutaotaotao/electron-prokit/actions/workflows/release.yml/badge.svg" alt="build status"></a>
    <a href="https://coveralls.io/github/Xutaotaotao/electron-prokit?branch=main"><img src="https://coveralls.io/repos/github/Xutaotaotao/electron-prokit/badge.svg?branch=main" alt="coveralls"></a>
    <a href="https://github.com/Xutaotaotao/electron-prokit/blob/main/LICENSE"><img src="https://img.shields.io/github/license/Xutaotaotao/electron-prokit?color=%232dce89&logo=github&style=flat-square" alt="license"></a>
    
  </p>
</div>



简体中文 | [English](./README_EN.md)


## ✨ 特性

- **💡 快速开始**: 脚手架工具助你一键快速开发Electron项目

- **⚡️ Vite支持**: 所有的进程配置使用方式与 Vite 相同

- **🛠️ 开箱即用**: 开箱即用支持 Typescript、Vue、React

- **📦 预设打包**: 一站式打包构建解决方案

- **🔥 热更新**: 所有进程及脚本都支持热更新

- **🔑 完全类型化**: 灵活的 API 和完整的 TypeScript 类型

- **🎨 丰富的API**: 进程通信、窗口管理、网络请求、跨语言调用、任务管理、数据库管理...

- **📺 最佳实践**: 提供 Electron 应用程序的最佳实践演示

## 👜 npm 包

|Package|npm version|npm downloads|
| :-: | :-: | :-: |
| [electron-prokit](packages/electron-prokit) | ![npm version](https://img.shields.io/npm/v/electron-prokit) | ![npm downloads](https://img.shields.io/npm/dt/electron-prokit) |
| [create-electron-prokit](packages/create-electron-prokit) | ![npm version](https://img.shields.io/npm/v/create-electron-prokit) | ![npm downloads](https://img.shields.io/npm/dt/create-electron-prokit) |
| [@electron-prokit/create-service](packages/create-service)| ![npm version](https://img.shields.io/npm/v/@electron-prokit/create-service) | ![npm downloads](https://img.shields.io/npm/dt/@electron-prokit/create-service) |

## 🔧 创建项目

直接使用脚手架快捷创建项目，脚手架结合了electron-prokit相关生态，推荐使用此方式。

使用 NPM:

```bash
npm create electron-prokit myapp
```

使用 Yarn:

```bash
yarn create electron-prokit myapp
```

其中`myapp`为你的项目名,然后按照提示操作即可！

## 📖 官方文档

<a href="https://xutaotaotao.github.io/electron-prokit/zh" target="_blank">文档首页</a>

<a href="https://xutaotaotao.github.io/electron-prokit/zh/api" target="_blank">API</a>

<a href="https://xutaotaotao.github.io/electron-prokit/zh/plugin" target="_blank">插件</a>

<a href="https://xutaotaotao.github.io/electron-prokit/zh/tutorials" target="_blank">教程</a>



## ⌨️ 演练

```bash
git clone https://github.com/Xutaotaotao/electron-prokit.git

pnpm i

pnpm run dev

```

## 📷 截图

<img src="https://github.com/Xutaotaotao/cloud_img/blob/master/ep-light.png" alt="light">

<img src="https://github.com/Xutaotaotao/cloud_img/blob/master/ep-dark.png" alt="dark">

## 📱 联系作者

微信扫码联系我

<img src="https://xutaotaotao.github.io/wx_qr.jpg" />



## 👥 支持者

[![Stargazers repo roster for electron-prokit](https://bytecrank.com/nastyox/reporoster/php/stargazersSVG.php?user=Xutaotaotao&repo=electron-prokit)](https://github.com/Xutaotaotao/electron-prokit/stargazers)

[![Forkers repo roster for @Xutaotaotao/electron-prokit](https://bytecrank.com/nastyox/reporoster/php/forkersSVG.php?user=Xutaotaotao&repo=electron-prokit)](https://github.com/Xutaotaotao/electron-prokit/network/members)