Skip to content

docs: replace npm mentions with pnpm #443

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
maximka76667 wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

docs: replace npm mentions with pnpm #443

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 17 additions & 17 deletions electron-app/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ When running in development mode (unpackaged), the application creates temporary

- `config.toml.backup-{timestamp}` - Automatic backup files created when importing a configuration. These timestamped backups help recover previous configurations if needed.

- `binaries/` - Directory containing compiled backend executables for your platform. These are generated during the build process, when running `npm run build`.
- `binaries/` - Directory containing compiled backend executables for your platform. These are generated during the build process, when running `pnpm run build`.

- `renderer/` - Directory containing built frontend views (control-station, ethernet-view). These are generated during the build process, when running `npm run build`.
- `renderer/` - Directory containing built frontend views (control-station, ethernet-view). These are generated during the build process, when running `pnpm run build`.

- `dist/` - Build output directory containing compiled and packaged application files. Generated during build and distribution processes, when running `npm run dist`.
- `dist/` - Build output directory containing compiled and packaged application files. Generated during build and distribution processes, when running `pnpm run dist`.

**Note**: These files and directories are created in the `electron-app/` directory root during development. In production (packaged) mode:

Expand Down Expand Up @@ -54,24 +54,24 @@ Typical locations:

```
# Install dependencies
npm install
pnpm install

# Build backend and frontends
npm run build
pnpm run build

# Run in development mode (you MUST run `npm run build` BEFORE!)
npm start
# Run in development mode (you MUST run `pnpm run build` BEFORE!)
pnpm start
```

## Build for production

This script creates distributables and executables.
**Note**: You must run `npm run build` for this script to work correctly.
**Note**: You must run `pnpm run build` for this script to work correctly.

```
npm run dist:win # Windows
npm run dist:mac # macOS
npm run dist:linux # Linux
pnpm run dist:win # Windows
pnpm run dist:mac # macOS
pnpm run dist:linux # Linux
```

### macOS Requirements
Expand All @@ -85,14 +85,14 @@ sudo ipconfig set en0 INFORM 127.0.0.9
## Available Scripts

```
- `npm run build` - Build all frontend views and backend
- `npm start` - Run application in development mode
- `npm run dist` - Build production executable
- `npm test` - Run tests
- `pnpm run build` - Build all frontend views and backend
- `pnpm start` - Run application in development mode
- `pnpm run dist` - Build production executable
- `pnpm test` - Run tests
...and many custom variations (see package.json)

# Only works and makes sense after running `npm run dist`
- `npm run asar:{platform}` - Shows .asar application package content for [win, linux, mac] platforms
# Only works and makes sense after running `pnpm run dist`
- `pnpm run asar:{platform}` - Shows .asar application package content for [win, linux, mac] platforms
```

## Architecture
Expand Down
Loading