diff --git a/README.md b/README.md index 3767f7f..9d01d04 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,42 @@ ![image](https://github.com/2skydev/electron-nestjs-react-vite-template/assets/43225384/431d3d65-8292-4189-977a-f13bb3dedd5e) -# electron + react + nestjs + vite template +# Electron + NestJS + React + Vite template + +Electron starter kit with multiple features
-## i18n support +## Features -The default language is set by detecting which language you use, and you can also change it directly on the Settings page. +- Electron + - Electron builder + - Electron store (json storage) + - Auto updater + - Update loading screen + - Auto launch + - NestJS + - [Standalone application](https://docs.nestjs.com/standalone-applications) + - IPC handler, sender decorator + - IPC preload script auto generate +- React + - File system based router (nextjs pages router like) +- i18n + - The default language is set by detecting which language you use
-## Features +## Overview framework & library + +- App framework: [`electron`](https://www.electronjs.org/) +- App build tool: [`electron-builder`](https://www.electron.build/) +- App storage: [`electron-store`](https://github.com/sindresorhus/electron-store) +- App auto updater: [`electron-updater`](https://www.electron.build/auto-update) +- Bundle tool: [`vite`](https://vitejs.dev/) + [`electron-vite`](https://electron-vite.org/) +- Main process framework: [`nestjs`](https://nestjs.com/) +- Renderer process framework: [`react`](https://react.dev/) + [`typescript`](https://www.typescriptlang.org/) +- Code style: `eslint` + `prettier` + [`@trivago/prettier-plugin-sort-imports`](https://github.com/trivago/prettier-plugin-sort-imports) +- File system based router: [`react-router-dom v6`](https://reactrouter.com/docs/en/v6) + custom (src/components/FileSystemRoutes) +- i18n: [`i18next`](https://www.i18next.com/) + [`react-i18next`](https://react.i18next.com/)
@@ -41,18 +67,3 @@ pnpm dev ```bash pnpm build ``` - -
- -## Overview framework & library - -- App framework: [`electron`](https://www.electronjs.org/) -- App build tool: [`electron-builder`](https://www.electron.build/) -- App storage: [`electron-store`](https://github.com/sindresorhus/electron-store) -- App auto updater: [`electron-updater`](https://www.electron.build/auto-update) -- Bundle tool: [`vite`](https://vitejs.dev/) + [`electron-vite`](https://electron-vite.org/) -- Main process framework: [`nestjs`](https://nestjs.com/) -- Renderer process framework: [`react`](https://react.dev/) + [`typescript`](https://www.typescriptlang.org/) -- Code style: `eslint` + `prettier` + [`@trivago/prettier-plugin-sort-imports`](https://github.com/trivago/prettier-plugin-sort-imports) -- File system based router: [`react-router-dom v6`](https://reactrouter.com/docs/en/v6) + custom (src/components/FileSystemRoutes) -- i18n: [`i18next`](https://www.i18next.com/) + [`react-i18next`](https://react.i18next.com/)