docs: add korean translations
This commit is contained in:
leejooy96 committed
1 parent
43d8aac5cb
commit
b64b66a6fe
26 files changed
+529
-20
No files matched your search
@@ -0,0 +1,25 @@
|
||||
# Main vs Renderer Process
|
||||
|
||||
A **Vutron** application is divided into code into a Main process and a Renderer process.
|
||||
|
||||
**"Main"** is the code of `src/main` and is mainly the process code handled by Electron. **"Renderer"** is the code of `src/renderer`, mainly for front-end rendering process like Vue.
|
||||
|
||||
In general, **Node.js** scripts cannot be run in the renderer process. Examples include modules that contain APIs used by Node.js, or native modules of **Node.js** such as `path` or `net`, `os` or `crypto`.
|
||||
|
||||
Preload scripts are run before the renderer is loaded. It creates a bridge to the main process to keep the execution of Node.js scripts in the renderer area separate and isolated for security reasons.
|
||||
|
||||
For secure script execution, it is recommended that the main process executes the Node scripts, and the renderer receives the execution results via messaging. This can be implemented via **IPC communication**.
|
||||
|
||||
For more information on this, see the following articles: https://www.electronjs.org/docs/latest/tutorial/ipc
|
||||
|
||||
### How to run Node.js on a renderer?
|
||||
|
||||
If you want to skip the security issues and use Node.js scripts in your renderer, you need to set `nodeIntegration` to `true` in your `vite.config.ts` file.
|
||||
|
||||
```javascript
|
||||
rendererPlugin({
|
||||
nodeIntegration: true
|
||||
})
|
||||
```
|
||||
|
||||
For more information on this, see the following articles: https://github.com/electron-vite/vite-plugin-electron-renderer
|
||||
@@ -0,0 +1,24 @@
|
||||
# Preload Script
|
||||
|
||||
The preload script in Electron.js is a secure area designed for communication between the main and renderer processes. It is typically used for **[IPC communication](https://www.electronjs.org/docs/latest/tutorial/ipc)**.
|
||||
|
||||
For more information, see the following articles https://www.electronjs.org/docs/latest/tutorial/tutorial-preload
|
||||
|
||||
For compatibility and security with the latest version of Electron, we do not recommend using the old `electron/remote` module. If you want to utilize system events or Node scripts, it is recommended to do so in the main process, not the renderer.
|
||||
|
||||
Vutron's preload script is located in the `src/preload` folder. To create a new IPC communication channel, add the channel name to the following variable to whitelist it for communication.
|
||||
|
||||
- `mainAvailChannels`: Send an event from main to renderer. (`window.mainApi.send('channelName')`)
|
||||
- `rendererAvailChannels`: Send an event from renderer to main. (`mainWindow.webContents.send('channelName')`)
|
||||
|
||||
When sending events from renderer to main, you access the `window.mainApi` object instead of `ipcRenderer.send`. The `mainApi` is the name you set in your Vutron template and can be changed.
|
||||
|
||||
Here are the supported functions for mainApi:
|
||||
|
||||
- `send`: Send an event to main.
|
||||
- `on`: A listener to receive events sent by main.
|
||||
- `once`: A listener to receive events sent by main. (Handle only one call)
|
||||
- `off`: Remove an event listener
|
||||
- `invoke`: Functions that can send events to main and receive data asynchronously.
|
||||
|
||||
To change and modify this, you need to modify `exposeInMainWorld` in `src/preload/index.ts`.
|
||||
@@ -0,0 +1,32 @@
|
||||
---
|
||||
layout: home
|
||||
|
||||
title: Vutron
|
||||
titleTemplate: Quick Start Templates for Vite + Vue 3 + Electron
|
||||
|
||||
hero:
|
||||
name: Vutron
|
||||
text: Quick Start Templates for Vite + Vue 3 + Electron
|
||||
tagline: <strong>Vutron</strong> is a preconfigured template for developing `Electron` cross-platform desktop apps. It uses `Vue 3` and allows you to build a fast development environment with little effort.
|
||||
actions:
|
||||
- theme: brand
|
||||
text: Getting Started
|
||||
link: /installation-and-build/getting-started
|
||||
- theme: alt
|
||||
text: GitHub
|
||||
link: https://github.com/jooy2/vutron
|
||||
image:
|
||||
src: /icon.png
|
||||
alt: Vue
|
||||
|
||||
features:
|
||||
- icon: <svg width="48" height="48" viewBox="0 0 48 48" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M5.03628 7.87818C4.75336 5.83955 6.15592 3.95466 8.16899 3.66815L33.6838 0.0367403C35.6969 -0.24977 37.5581 1.1706 37.841 3.20923L42.9637 40.1218C43.2466 42.1604 41.8441 44.0453 39.831 44.3319L14.3162 47.9633C12.3031 48.2498 10.4419 46.8294 10.159 44.7908L5.03628 7.87818Z" fill="url(#paint0_linear_1287_1214)"/><path d="M6.85877 7.6188C6.71731 6.59948 7.41859 5.65703 8.42512 5.51378L33.9399 1.88237C34.9465 1.73911 35.8771 2.4493 36.0186 3.46861L41.1412 40.3812C41.2827 41.4005 40.5814 42.343 39.5749 42.4862L14.0601 46.1176C13.0535 46.2609 12.1229 45.5507 11.9814 44.5314L6.85877 7.6188Z" fill="white"/><path d="M33.1857 14.9195L25.8505 34.1576C25.6991 34.5547 25.1763 34.63 24.9177 34.2919L12.3343 17.8339C12.0526 17.4655 12.3217 16.9339 12.7806 16.9524L22.9053 17.3607C22.9698 17.3633 23.0344 17.3541 23.0956 17.3337L32.5088 14.1992C32.9431 14.0546 33.3503 14.4878 33.1857 14.9195Z" fill="url(#paint1_linear_1287_1214)"/><path d="M27.0251 12.5756L19.9352 15.0427C19.8187 15.0832 19.7444 15.1986 19.7546 15.3231L20.3916 23.063C20.4066 23.2453 20.5904 23.3628 20.7588 23.2977L22.7226 22.5392C22.9064 22.4682 23.1021 22.6138 23.0905 22.8128L22.9102 25.8903C22.8982 26.0974 23.1093 26.2436 23.295 26.1567L24.4948 25.5953C24.6808 25.5084 24.892 25.6549 24.8795 25.8624L24.5855 30.6979C24.5671 31.0004 24.9759 31.1067 25.1013 30.8321L25.185 30.6487L29.4298 17.8014C29.5008 17.5863 29.2968 17.3809 29.0847 17.454L27.0519 18.1547C26.8609 18.2205 26.6675 18.0586 26.6954 17.8561L27.3823 12.8739C27.4103 12.6712 27.2163 12.5091 27.0251 12.5756Z" fill="url(#paint2_linear_1287_1214)"/><defs><linearGradient id="paint0_linear_1287_1214" x1="6.48163" y1="1.9759" x2="39.05" y2="48.2064" gradientUnits="userSpaceOnUse"><stop stop-color="#49C7FF"/><stop offset="1" stop-color="#BD36FF"/></linearGradient><linearGradient id="paint1_linear_1287_1214" x1="11.8848" y1="16.4266" x2="26.7246" y2="31.4177" gradientUnits="userSpaceOnUse"><stop stop-color="#41D1FF"/><stop offset="1" stop-color="#BD34FE"/></linearGradient><linearGradient id="paint2_linear_1287_1214" x1="21.8138" y1="13.7046" x2="26.2464" y2="28.8069" gradientUnits="userSpaceOnUse"><stop stop-color="#FFEA83"/><stop offset="0.0833333" stop-color="#FFDD35"/><stop offset="1" stop-color="#FFA800"/></linearGradient></defs></svg>
|
||||
title: Powerful web application development templates
|
||||
details: Vutron supports cross-platform, multi-language, layouts and theme, and style frameworks.
|
||||
- icon: <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 80 80" width="160px" height="160px"><path fill="#424e5c" d="M4.5 6.5H75.5V73.5H4.5z"/><path fill="#afc5d8" d="M75,7v66H5V7H75 M76,6H4v68h72V6L76,6z"/><path fill="#afc5d8" d="M4 6H76V18H4z"/><path fill="#bae0bd" d="M25.6 43H54.400000000000006V45H25.6z" transform="rotate(-69.666 39.998 43.999)"/><path fill="#bae0bd" d="M27.9 54.4L16 44 27.9 33.6 29.2 35.1 19 44 29.2 52.9zM52.2 54.5L50.9 53 61 44.1 50.9 35.1 52.2 33.6 64 44.1z"/></svg>
|
||||
title: Rapid development through hot-reload
|
||||
details: Reduce initial project setup time with maximum feature support for developers.
|
||||
- icon: <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 32 32" width="64px" height="64px"><circle cx="16" cy="17" r="5" fill="#ed0049"/><path fill="#ed0049" d="M23,31H9v0c0-3.866,3.134-7,7-7h0C19.866,24,23,27.134,23,31L23,31z"/><path fill="#0f518c" d="M19,4c0-1.657-1.343-3-3-3s-3,1.343-3,3c0,0.885,0.391,1.672,1,2.222V10h4V6.222 C18.609,5.672,19,4.885,19,4z"/><path fill="#0f518c" d="M7.061,8.318c-1.171-1.171-3.071-1.171-4.243,0s-1.171,3.071,0,4.243 c0.626,0.626,1.459,0.906,2.278,0.864l2.672,2.672l2.828-2.828l-2.672-2.672C7.967,9.777,7.686,8.944,7.061,8.318z"/><path fill="#0f518c" d="M24.879,8.318c1.171-1.171,3.071-1.171,4.243,0s1.171,3.071,0,4.243 c-0.626,0.626-1.459,0.906-2.278,0.864l-2.672,2.672l-2.828-2.828l2.672-2.672C23.972,9.777,24.253,8.944,24.879,8.318z"/><path fill="#0f518c" d="M24.879,27.218c1.171,1.171,3.071,1.171,4.243,0c1.171-1.171,1.171-3.071,0-4.243 c-0.626-0.626-1.459-0.906-2.278-0.864l-2.672-2.672l-2.828,2.828l2.672,2.672C23.972,25.759,24.253,26.592,24.879,27.218z"/><g><path fill="#0f518c" d="M7.061,27.218c-1.171,1.171-3.071,1.171-4.243,0c-1.171-1.171-1.171-3.071,0-4.243 c0.626-0.626,1.459-0.906,2.278-0.864l2.672-2.672l2.828,2.828L7.925,24.94C7.967,25.759,7.686,26.592,7.061,27.218z"/></g></svg>
|
||||
title: Reliable maintenance support
|
||||
details: There are many real-world use cases, and we have fast technical support.
|
||||
---
|
||||
@@ -0,0 +1,23 @@
|
||||
---
|
||||
order: 4
|
||||
---
|
||||
|
||||
# Automated Testing
|
||||
|
||||
**Vutron** includes automated testing. The testing framework uses Microsoft's **[Playwright](https://playwright.dev)**.
|
||||
|
||||
**Playwright** is optimized for web application testing and has full support for the **Electron** framework. It is simple to install, requires no configuration to start testing immediately, and is cross-platform. You can learn more about **Playwright** here: https://github.com/microsoft/playwright
|
||||
|
||||
Only very simple launch and behavioral tests for the template main screen have been implemented in this template. Advanced testing will depend on the scope of your application.
|
||||
|
||||
Currently, the test specification file is located in the `tests` directory and the test results file is located in `tests/results`. (The built-in test specification file does not generate a separate results file.)
|
||||
|
||||
The Playwright configuration is `playwright.config.ts` in the project root, see the following documentation for more information on this: https://playwright.dev/docs/test-configuration
|
||||
|
||||
Once everything is configured, you can run a test with the following command.
|
||||
|
||||
```shell
|
||||
$ npm run test
|
||||
```
|
||||
|
||||
Before running the test, empty the build directory (`dist`) and compile the package for the test.
|
||||
@@ -0,0 +1,84 @@
|
||||
---
|
||||
order: 2
|
||||
---
|
||||
|
||||
# Build Configurations
|
||||
|
||||
Once the module installation is complete, you can simply build the platform package with the command below.
|
||||
|
||||
```shell
|
||||
# For Windows (.exe, .appx)
|
||||
$ npm run build:win
|
||||
|
||||
# For macOS (.dmg)
|
||||
$ npm run build:mac
|
||||
|
||||
# For Linux (.rpm, .deb, .snap)
|
||||
$ npm run build:linux
|
||||
|
||||
# All platform (.exe, .appx, .dmg, .rpm, .deb, .snap) - see below description
|
||||
$ npm run build:all
|
||||
```
|
||||
|
||||
The built packages can be found in `release/{version}` location.
|
||||
|
||||
For more information, please refer to the following article: https://webpack.electron.build/dependency-management#installing-native-node-modules
|
||||
|
||||
## What do I need to do for a multi-platform build?
|
||||
|
||||
To create a package for each OS, you must build it on the same OS. For example, a package for macOS must be built on a macOS machine.
|
||||
|
||||
However, you can build packages for Windows, macOS, and Linux all at once on one OS. However, this might require some preparation.
|
||||
|
||||
**macOS** is recommended if you want to build multiple platforms simultaneously on one platform. Because it can be configured with just a few very simple settings.
|
||||
|
||||
You can perform multi-platform builds at once with the following command. Alternatively, you can just do it for the OS you want via the individual build commands above.
|
||||
|
||||
```shell
|
||||
$ npm run build:all
|
||||
```
|
||||
|
||||
`Multipass` configuration may be required for Linux builds. Learn more about `Multipass` through the following link: https://multipass.run
|
||||
|
||||
To learn more about multiplatform builds, see the following articles: https://electron.build/multi-platform-build
|
||||
|
||||
## Reduce bundle size by excluding development files
|
||||
|
||||
You can exclude files you don't need at build time by adding a file pattern to the files property of `buildAssets/builder/config.ts`. This will save bundle capacity.
|
||||
|
||||
Below is an unnecessary `node_modules` file pattern that can further save bundles. Depending on the project, using the rules below may cause problems, so please review it before using.
|
||||
|
||||
```json
|
||||
[
|
||||
"!**/.*",
|
||||
"!**/node_modules/**/{CONTRIBUTORS,CNAME,AUTHOR,TODO,CONTRIBUTING,COPYING,INSTALL,NEWS,PORTING,Makefile,htdocs,CHANGELOG,ChangeLog,changelog,README,Readme,readme,test,sample,example,demo,composer.json,tsconfig.json,jsdoc.json,tslint.json,typings.json,gulpfile,bower.json,package-lock,Gruntfile,CMakeLists,karma.conf,yarn.lock}*",
|
||||
"!**/node_modules/**/{man,benchmark,node_modules,spec,cmake,browser,vagrant,doxy*,bin,obj,obj.target,example,examples,test,tests,doc,docs,msvc,Xcode,CVS,RCS,SCCS}{,/**/*}",
|
||||
"!**/node_modules/**/*.{conf,png,pc,coffee,txt,spec.js,ts,js.flow,html,def,jst,xml,ico,in,ac,sln,dsp,dsw,cmd,vcproj,vcxproj,vcxproj.filters,pdb,exp,obj,lib,map,md,sh,gypi,gyp,h,cpp,yml,log,tlog,Makefile,mk,c,cc,rc,xcodeproj,xcconfig,d.ts,yaml,hpp}",
|
||||
"!**/node_modules/**/node-v*-x64{,/**/*}",
|
||||
"!**/node_modules/bluebird/js/browser{,/**/*}",
|
||||
"!**/node_modules/bluebird/js/browser{,/**/*}",
|
||||
"!**/node_modules/source-map/dist{,/**/*}",
|
||||
"!**/node_modules/lodash/fp{,/**/*}",
|
||||
"!**/node_modules/async/!(dist|package.json)",
|
||||
"!**/node_modules/async/internal{,/**/*}",
|
||||
"!**/node_modules/ajv/dist{,/**/*}",
|
||||
"!**/node_modules/ajv/scripts{,/**/*}",
|
||||
"!**/node_modules/node-pre-gyp/!(lib|package.json)",
|
||||
"!**/node_modules/node-pre-gyp/lib/!(util|pre-binding.js|node-pre-gyp.js)",
|
||||
"!**/node_modules/node-pre-gyp/lib/util/!(versioning.js|abi_crosswalk.json)",
|
||||
"!**/node_modules/source-map-support/browser-source-map-support.js",
|
||||
"!**/node_modules/json-schema/!(package.json|lib)"
|
||||
]
|
||||
```
|
||||
|
||||
## Build settings for projects that use Native Node modules
|
||||
|
||||
For projects that use the **Native Node Module**, add the following script to your `package.json`: When installing dependencies, `electron-builder` will take care of any modules that require rebuilding.
|
||||
|
||||
```json
|
||||
{
|
||||
"scripts": {
|
||||
"postinstall": "electron-builder install-app-deps"
|
||||
}
|
||||
}
|
||||
```
|
||||
@@ -0,0 +1,58 @@
|
||||
---
|
||||
order: 1
|
||||
---
|
||||
|
||||
# Getting Started
|
||||
|
||||
## Clone project
|
||||
|
||||
### Method 1: `npm init` (Recommend)
|
||||
|
||||
You can easily clone a repository with just the npm command.
|
||||
|
||||
```shell
|
||||
$ npm init vutron
|
||||
```
|
||||
|
||||
The above method will not create unnecessary documentation and `.github` related files for your project.
|
||||
|
||||
### Method 2: Use this template
|
||||
|
||||
Click **[Use this template](https://github.com/jooy2/vutron/generate)** to instantly create your own project.
|
||||
|
||||
This method creates a repository on GitHub immediately, but you will need to clone the project locally before you can use it.
|
||||
|
||||
### Method 3: Clone this repository
|
||||
|
||||
Clone this repo using below command. This method is suitable for direct contributions to the Vutron repository.
|
||||
|
||||
```shell
|
||||
$ git clone https://github.com/jooy2/vutron <PROJECT_NAME>
|
||||
```
|
||||
|
||||
## Installation
|
||||
|
||||
After cloning the project, run the following command in the terminal:
|
||||
|
||||
```shell
|
||||
# via npm
|
||||
$ npm i
|
||||
|
||||
# via yarn (https://yarnpkg.com)
|
||||
$ yarn install
|
||||
|
||||
# via pnpm (https://pnpm.io)
|
||||
$ pnpm i
|
||||
```
|
||||
|
||||
## Run in development environment
|
||||
|
||||
Applications in the development environment run through **[Vite](https://vitejs.dev)**.
|
||||
|
||||
```shell
|
||||
$ npm run dev
|
||||
```
|
||||
|
||||
If your application doesn't appear after running command line commands, you may need to review if the default port is being used by another app.
|
||||
|
||||
Vite uses port `5173` by default.
|
||||
@@ -0,0 +1,36 @@
|
||||
---
|
||||
order: 5
|
||||
---
|
||||
|
||||
# Manage Local Documentation
|
||||
|
||||
Documents from `Vutron` can be viewed in the local environment through the `VitePress` viewer.
|
||||
|
||||
This function works only when the entire project is cloned. If you created the project with `npm init vutron`, the `docs` folder is not included.
|
||||
|
||||
## Installation
|
||||
|
||||
Everything in the instructions below should be done in the `docs` folder.
|
||||
|
||||
```shell
|
||||
$ cd docs
|
||||
```
|
||||
|
||||
Install the relevant packages using the following commands:
|
||||
|
||||
```shell
|
||||
# via npm
|
||||
$ npm i
|
||||
|
||||
# via yarn (https://yarnpkg.com)
|
||||
$ yarn install
|
||||
|
||||
# via pnpm (https://pnpm.io)
|
||||
$ pnpm i
|
||||
```
|
||||
|
||||
You can run the local server where the documents are hosted via the command below.
|
||||
|
||||
```shell
|
||||
$ npm run dev
|
||||
```
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
title: NPM Scripts
|
||||
order: 3
|
||||
---
|
||||
|
||||
# Npm Scripts
|
||||
|
||||
> $ npm run %SCRIPT_NAME%
|
||||
|
||||
## General
|
||||
|
||||
| Script Name | Description |
|
||||
| --- | --- |
|
||||
| `dev` | Start Electron as a development environment |
|
||||
| `dev:debug` | Start Electron as a development environment (with vite debug) |
|
||||
| `dev:debug:force` | Start Electron as a development environment (with vite debug + clean vite cache) |
|
||||
| `build:pre` | Commands commonly run at build time. This script does not need to be run separately. |
|
||||
| `build` | Build the package for the current operating system. |
|
||||
| `build:all` | Build a specified package for the entire operating system (Requires cross-platform build configuration) |
|
||||
| `build:dir` | `electron-builder` directory build |
|
||||
| `build:mac` | Build preconfigured packages for macOS |
|
||||
| `build:linux` | Build preconfigured packages for Linux |
|
||||
| `build:win` | Build preconfigured packages for Windows |
|
||||
| `lint` | ESLint code inspection. It does not modify the code. |
|
||||
| `lint:fix` | ESLint code inspection. Use auto-fix to fix your code. |
|
||||
| `format` | Prettier code inspection. It does not modify the code. |
|
||||
| `format:fix` | Prettier code inspection. Use auto-fix to fix your code. |
|
||||
| `test` | Build a package for testing and run tests against the test specification file. |
|
||||
| `test:linux` | Build a package for testing and run tests against the test specification file. (for linux ci only) |
|
||||
|
||||
## For Documentation
|
||||
|
||||
Used only for contributing to project documentation. Must be run from the `docs` directory location.
|
||||
|
||||
| Script Name | Description |
|
||||
| ----------- | ------------------------------------------------------------------ |
|
||||
| `dev` | Start the local document server. (For development) |
|
||||
| `build` | Build a local document server. Used only for GitHub page builders. |
|
||||
| `serve` | Start the local document server. |
|
||||
@@ -0,0 +1,15 @@
|
||||
# Other Projects
|
||||
|
||||
## Looking for Electron templates made with React?
|
||||
|
||||
Also check out the `Retron` project, which consists of Vite + React + Material-UI + Electron.
|
||||
|
||||
https://github.com/jooy2/retron
|
||||
|
||||
## (Deprecated) Looking for `Vutron` with Webpack 5 compiler?
|
||||
|
||||
By using the Vite compiler, we achieved our goals of reducing project and bundle size, and improving development environment and build speed.
|
||||
|
||||
The old **Vutron** using the Webpack 5 compiler has been split into the repositories below and will end support soon.
|
||||
|
||||
https://github.com/jooy2/vutron-webpack
|
||||
@@ -0,0 +1,32 @@
|
||||
---
|
||||
order: 2
|
||||
---
|
||||
|
||||
# Pre-configured Components
|
||||
|
||||
## Web app frameworks
|
||||
|
||||
- [Vite](https://vitejs.dev)
|
||||
- [Electron](https://www.electronjs.org)
|
||||
- [Electron Builder](https://www.electron.build)
|
||||
|
||||
## Development help tools
|
||||
|
||||
- [TypeScript](https://www.typescriptlang.org)
|
||||
- [ESLint](https://eslint.org)
|
||||
- [Prettier](https://prettier.io)
|
||||
|
||||
## Front-end frameworks (Vue)
|
||||
|
||||
- [Vue](https://vuejs.org)
|
||||
- [Vue-i18n](https://kazupon.github.io/vue-i18n)
|
||||
- [Vue-router](https://router.vuejs.org)
|
||||
- [Pinia](https://pinia.vuejs.org)
|
||||
|
||||
## Design frameworks
|
||||
|
||||
- [Vuetify](https://vuetifyjs.com)
|
||||
|
||||
## Testing
|
||||
|
||||
- [Playwright](https://playwright.dev)
|
||||
@@ -0,0 +1,73 @@
|
||||
---
|
||||
order: 1
|
||||
---
|
||||
|
||||
# Project Structure
|
||||
|
||||
```
|
||||
/
|
||||
├─ .github - GitHub files (only used for Vutron GitHub project contributions)
|
||||
│ └─ ISSUE_TEMPLATE/
|
||||
│ └─ resources/ - GitHub resources used for README.md, etc.
|
||||
│ └─ workflows/ - GitHub workflows definition
|
||||
│ └─ dependabot.yml
|
||||
│ └─ FUNDING.yml
|
||||
├─ .vscode - Common project configuration files used by Visual Studio Code IDE
|
||||
├─ buildAssets/ - Package resource (icon, logo, etc.) file used for Electron build
|
||||
│ └─ builder/
|
||||
│ │ │ └─ config.ts - `electron-builder` dynamic configuration file
|
||||
│ └─ icons/
|
||||
├─ dist/ - Output directory used to build the package
|
||||
├─ docs/ - Project documents (optionally enabled)
|
||||
│ └─ .vitepress/
|
||||
│ │ │ └─ config.mts - VitePress configuration file used for document hosting
|
||||
│ └─ public/ - Root resource directory for VitePress documentation pages
|
||||
├─ node_modules/
|
||||
├─ src/
|
||||
│ ├─ main/ - Main (Electron) process source code
|
||||
│ │ ├─ utils/ - Main process utilities
|
||||
│ │ │ └─ Constants.ts - Main global definition
|
||||
│ │ │ └─ Menus.ts - Main global menu definition
|
||||
│ │ └─ index.ts - Main process entry point
|
||||
│ │ └─ IPCs.ts - Main process ipc handlers definition
|
||||
│ │ └─ MainRunner.ts - Main process main window processing
|
||||
│ ├─ preload/ - Preload (Electron-Vue communication bridge) process source code
|
||||
│ │ └─ index.ts
|
||||
│ ├─ renderer/ - Renderer (Vue) process source code
|
||||
│ │ ├─ components/ - Vue components collection
|
||||
│ │ │ └─ layout/ - Layout components
|
||||
│ │ ├─ locales/ - Vue i18n language resource file
|
||||
│ │ ├─ plugins/ - Vue plugin definition
|
||||
│ │ ├─ public/ - Vue static resources
|
||||
│ │ │ └─ images/
|
||||
│ │ ├─ router/ - Vue routing definition
|
||||
│ │ ├─ screens/ - Vue screen component
|
||||
│ │ │ └─ ErrorScreen.vue - Screen displayed when renderer process and routing errors occur
|
||||
│ │ │ └─ MainScreen.vue
|
||||
│ │ │ └─ SecondScreen.vue - Sample screen
|
||||
│ │ ├─ store/ - Pinia store (Global state management) definition
|
||||
│ │ ├─ utils/ - Renderer process utilities
|
||||
│ │ ├─ App.vue - Vue app's root component
|
||||
│ │ ├─ index.html - Root static index loaded by Electron renderer process
|
||||
│ └─ └─ main.ts - Renderer process entry point
|
||||
├─ tests/ - Application test configuration
|
||||
│ ├─ results/ - Where to save PlayWright test result files and screenshots
|
||||
│ ├─ specs/ - PlayWright test spec file
|
||||
│ ├─ fixtures.ts - Test common execution API
|
||||
│ └─ testUtil.ts - Test utilities
|
||||
├─ .editorconfig - Editor recommended configuration file for IDE
|
||||
├─ .eslintignore - List of files to be ignored by ESLint
|
||||
├─ .eslintrc.json - ESLint rule configurations
|
||||
├─ .gitignore - List of files to not upload to Git
|
||||
├─ .prettierignore - List of files to disable Prettier file formatting
|
||||
├─ .prettierrc - Prettier rule configurations
|
||||
├─ CODE_OF_CONDUCT.md - Files used only on GitHub
|
||||
├─ LICENSE - Project license file
|
||||
├─ package.json - Node.js package configurations
|
||||
├─ package-lock.json
|
||||
├─ playwright.config.ts - Playwright test rules configurations
|
||||
├─ tsconfig.json - TypeScript configurations
|
||||
├─ tsconfig.node.json - TypeScript configurations
|
||||
├─ vite.config.mts - Vite compiler build configurations
|
||||
└─ README.md - Files used only on GitHub
|
||||
```
|
||||
Reference in new issue
Block a user