Upstream/waveterm
1
0
Fork 0
mirror of https://github.com/wavetermdev/waveterm.git synced 2025-01-06 19:18:22 +01:00
Code Issues Packages Projects Releases Wiki Activity

add aliases for electron:dev, electron:start, and docsite:start tasks (#1651)

Browse Source
This commit is contained in:
Evan Simkowitz 2024-12-29 13:05:17 -05:00 committed by GitHub
parent 0890475a60
commit cb2cd72cd4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
BUILD.md
View File

@ -112,7 +112,7 @@ All the methods below will install Node and Go dependencies when they run the fi
Run the following command to build the app and run it via Vite's development server (this enables Hot Module Reloading): Run the following command to build the app and run it via Vite's development server (this enables Hot Module Reloading):
```sh ```sh
task electron:dev task dev
``` ```
### Standalone ### Standalone
@ -120,7 +120,7 @@ task electron:dev
Run the following command to build the app and run it standalone, without the development server. This will not reload on change: Run the following command to build the app and run it standalone, without the development server. This will not reload on change:
```sh ```sh
task electron:start task start
``` ```
### Packaged ### Packaged

6
Taskfile.yml
View File

@ -19,6 +19,8 @@ tasks:
electron:dev: electron:dev:
desc: Run the Electron application via the Vite dev server (enables hot reloading). desc: Run the Electron application via the Vite dev server (enables hot reloading).
cmd: yarn dev cmd: yarn dev
aliases:
- dev
deps: deps:
- yarn - yarn
- docsite:build:embedded - docsite:build:embedded
@ -30,6 +32,8 @@ tasks:
electron:start: electron:start:
desc: Run the Electron application directly. desc: Run the Electron application directly.
cmd: yarn start cmd: yarn start
aliases:
- start
deps: deps:
- yarn - yarn
- docsite:build:embedded - docsite:build:embedded
@ -56,6 +60,8 @@ tasks:
desc: Start the docsite dev server. desc: Start the docsite dev server.
cmd: yarn start cmd: yarn start
dir: docs dir: docs
aliases:
- docsite
deps: deps:
- yarn - yarn

4
docs/README.md
View File

@ -13,7 +13,7 @@ yarn
### Local Development ### Local Development
```sh ```sh
yarn start task docsite
``` ```
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
@ -21,7 +21,7 @@ This command starts a local development server and opens up a browser window. Mo
### Build ### Build
```sh ```sh
yarn build task docsite:build:<embedded,public>
``` ```
This command generates static content into the `build` directory and can be served using any static contents hosting service. This command generates static content into the `build` directory and can be served using any static contents hosting service.