Skip to content

Commit 7ee13dc

Browse files
committed
docs(readme): README 문서 업데이트
1 parent e4954a9 commit 7ee13dc

File tree

1 file changed

+30
-19
lines changed

1 file changed

+30
-19
lines changed

README.md

Lines changed: 30 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,42 @@
11
![image](https://github.com/2skydev/electron-nestjs-react-vite-template/assets/43225384/431d3d65-8292-4189-977a-f13bb3dedd5e)
22

3-
# electron + react + nestjs + vite template
3+
# Electron + NestJS + React + Vite template
4+
5+
Electron starter kit with multiple features
46

57
<br/>
68

7-
## i18n support
9+
## Features
810

9-
The default language is set by detecting which language you use, and you can also change it directly on the Settings page.
11+
- Electron
12+
- Electron builder
13+
- Electron store (json storage)
14+
- Auto updater
15+
- Update loading screen
16+
- Auto launch
17+
- NestJS
18+
- [Standalone application](https://docs.nestjs.com/standalone-applications)
19+
- IPC handler, sender decorator
20+
- IPC preload script auto generate
21+
- React
22+
- File system based router (nextjs pages router like)
23+
- i18n
24+
- The default language is set by detecting which language you use
1025

1126
<br/>
1227

13-
## Features
28+
## Overview framework & library
29+
30+
- App framework: [`electron`](https://www.electronjs.org/)
31+
- App build tool: [`electron-builder`](https://www.electron.build/)
32+
- App storage: [`electron-store`](https://github.com/sindresorhus/electron-store)
33+
- App auto updater: [`electron-updater`](https://www.electron.build/auto-update)
34+
- Bundle tool: [`vite`](https://vitejs.dev/) + [`electron-vite`](https://electron-vite.org/)
35+
- Main process framework: [`nestjs`](https://nestjs.com/)
36+
- Renderer process framework: [`react`](https://react.dev/) + [`typescript`](https://www.typescriptlang.org/)
37+
- Code style: `eslint` + `prettier` + [`@trivago/prettier-plugin-sort-imports`](https://github.com/trivago/prettier-plugin-sort-imports)
38+
- File system based router: [`react-router-dom v6`](https://reactrouter.com/docs/en/v6) + custom (src/components/FileSystemRoutes)
39+
- i18n: [`i18next`](https://www.i18next.com/) + [`react-i18next`](https://react.i18next.com/)
1440

1541
<br/>
1642

@@ -41,18 +67,3 @@ pnpm dev
4167
```bash
4268
pnpm build
4369
```
44-
45-
<br/>
46-
47-
## Overview framework & library
48-
49-
- App framework: [`electron`](https://www.electronjs.org/)
50-
- App build tool: [`electron-builder`](https://www.electron.build/)
51-
- App storage: [`electron-store`](https://github.com/sindresorhus/electron-store)
52-
- App auto updater: [`electron-updater`](https://www.electron.build/auto-update)
53-
- Bundle tool: [`vite`](https://vitejs.dev/) + [`electron-vite`](https://electron-vite.org/)
54-
- Main process framework: [`nestjs`](https://nestjs.com/)
55-
- Renderer process framework: [`react`](https://react.dev/) + [`typescript`](https://www.typescriptlang.org/)
56-
- Code style: `eslint` + `prettier` + [`@trivago/prettier-plugin-sort-imports`](https://github.com/trivago/prettier-plugin-sort-imports)
57-
- File system based router: [`react-router-dom v6`](https://reactrouter.com/docs/en/v6) + custom (src/components/FileSystemRoutes)
58-
- i18n: [`i18next`](https://www.i18next.com/) + [`react-i18next`](https://react.i18next.com/)

0 commit comments

Comments
 (0)