README.md

electron-template-next

Quick to build a modern electron app！

Features ✨

• 🏗️ bootstrap by vite & electron
• 📸 ui-framework by react
• 🔍 type-check by typescript
• 🏭 build by tsc & vite & electron-builder
• 🖼️ ui-component by @mui/material
• 🎛️ state-management by zustand
• ⚓ component-router by react-router
• 🪝 react-hooks by ahooks
• 📡 http-client by react-query
• 🎭 create immutable-state by immer
• 📅 date-tools by dayjs
• 🏘️ test-framework by vitest
• 🐙 test by @testing-library
• 👀 lint-code by eslint & prettier
• 📊 test-coverage by c8
• 🕵️ commit-check by husky & lint-staged
• 🗃️ package-management by pnpm

About Env 🌌

• Node version need >=16
• You need install pnpm first!

  npm i -g pnpm

How to use? 🤨

Step1：clone this project
Step2：pnpm i
Step3：make your components in src/**
Step4: make your test code in test/**
Step5: run scripts (dev/build/preview/test/lint)

that's all, happy hacking!

Script 🪃

• dev
• build
• preview
• test
• lint

Catalog 📑

├─.vscode
├─dist
├─coverage
├─node_modules
├─public
├─.eslintrc
├─.eslintignore
├─.gitignore
├─.prettierrc
├─.prettierignore
├─index.html
├─package.json
├─pnpm-lock.yaml
├─README.md
├─tsconfig.json
├─vite.config.ts
├─electron
    ├─ipc_main
    ├─preloads
    ├─windows
    ├─electron-env.d.ts
    ├─env.ts
    └─index.ts
└─src
    ├─app
    | ├─@types
    | ├─apis
    | ├─components
    | ├─constants
    | ├─hooks
    | ├─pages
    | ├─routers
    | ├─stores
    | ├─theme
    | ├─utils
    | ├─App.tsx
    | └─index.ts
    ├─shared
    | ├─components
    | ├─hooks
    | └─utils
    ├─test
    | └─setup.ts
    ├─index.css
    ├─index.tsx
    └─env.d.ts