Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ciatph committed Sep 12, 2024
1 parent e6ac5f8 commit bc83198
Showing 1 changed file with 36 additions and 36 deletions.
72 changes: 36 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,18 +83,18 @@ Click to expand the table of contents
- [Interactive CLI Scripts](#interactive-cli-scripts)
- `npm start` / `npm run list:region`
- `npm run list:province`
- [NPM Scripts for Building Documentation](#npm-scripts-for-building-documentation)
- `npm run generate-docs`
- `npm run docs:install`
- `npm run docs:build`
- [NPM Scripts for Building Windows Executable Files of the Interactive CLI Scripts](#npm-scripts-for-building-windows-executable-files-of-the-interactive-cli-scripts)
- `build:win:region`
- `build:win:province`
- `build:win:all`
- `npm run build:win:region`
- `npm run build:win:province`
- `npm run build:win:all`
- `npm run minify:region`
- [NPM Scripts for Compiling the Interactive CLI Scripts into Stand-Alone Scripts](#npm-scripts-for-compiling-the-interactive-cli-scripts-into-stand-alone-scripts)
- `npm run minify:province`
- `npm run minify:all`
- [NPM Scripts for Building Documentation](#npm-scripts-for-building-documentation)
- `npm run generate-docs`
- `npm run docs:install`
- `npm run docs:build`
- [NPM Scripts for Linting Files and Unit Testing](#npm-scripts-for-linting-files-and-unit-testing)
- `npm run lint`
- `npm run lint:fix`
Expand Down Expand Up @@ -234,6 +234,32 @@ npm run list:region
---
<details>
<summary style="font-size: 18px;" id="npm-scripts-for-compiling-the-interactive-cli-scripts-into-stand-alone-scripts">
<b>NPM Scripts for Compiling the Interactive CLI Scripts into Stand-Alone Scripts</b>
</summary>
### `npm run minify:region`
- Compiles the Node.js project's `npm list:region` script and dependencies into a single script using [**ncc**](https://www.npmjs.com/package/@vercel/ncc).
- The compiled/minified file will be stored in `/dist/region`. Run the command to use the compiled script:<br>
`node dist/region`
### `npm run minify:province`
- Compiles the Node.js project's `npm list:province` script and dependencies into a single script using [**ncc**](https://www.npmjs.com/package/@vercel/ncc).
- The compiled/minified file will be stored in `/dist/province`. Run the command to use the compiled script:<br>
`node dist/province`
### `npm run minify:all`
- Run the `npm list:region` and `npm list:province` scripts in one go.
- Each compiled/minified files will be stored in the `/dist` directory.
</details>
---
<details>
<summary style="font-size: 18px;" id="npm-scripts-for-building-documentation">
<b>NPM Scripts for Building Documentation</b>
Expand Down Expand Up @@ -288,17 +314,17 @@ docker exec -u root -it ph-municipalities npm run docs:build
<b>NPM Scripts for Building Windows Executable Files of the Interactive CLI Scripts</b>
</summary>

### `build:win:region`
### `npm run build:win:region`

- Package the Node.js project's `npm start` script into a stand-alone windows `node16-win-x64` executable.
- The windows executable file will be stored in `/dist/ph-regions-win.exe`. Click the executable file to run.

### `build:win:province`
### `npm run build:win:province`

- Package the Node.js project's `npm list:province` script into a stand-alone windows `node16-win-x64` executable.
- The windows executable file will be stored in `/dist/ph-provinces-win.exe`. Click the executable file to run.

### `build:win:all`
### `npm run build:win:all`

- Package the Node.js project's `npm start` and `npm list:province` script into a stand-alone windows `node16-win-x64` executables in one go.
- Each window executable file will be stored in the `/dist` directory.
Expand All @@ -307,32 +333,6 @@ docker exec -u root -it ph-municipalities npm run docs:build

---

<details>
<summary style="font-size: 18px;" id="npm-scripts-for-compiling-the-interactive-cli-scripts-into-stand-alone-scripts">
<b>NPM Scripts for Compiling the Interactive CLI Scripts into Stand-Alone Scripts</b>
</summary>

### `npm run minify:region`

- Compiles the Node.js project's `npm list:region` script and dependencies into a single script using [**ncc**](https://www.npmjs.com/package/@vercel/ncc).
- The compiled/minified file will be stored in `/dist/region`. Run the command to use the compiled script:<br>
`node dist/region`

### `npm run minify:province`

- Compiles the Node.js project's `npm list:province` script and dependencies into a single script using [**ncc**](https://www.npmjs.com/package/@vercel/ncc).
- The compiled/minified file will be stored in `/dist/province`. Run the command to use the compiled script:<br>
`node dist/province`

### `npm run minify:all`

- Run the `npm list:region` and `npm list:province` scripts in one go.
- Each compiled/minified files will be stored in the `/dist` directory.

</details>

---

<details>
<summary style="font-size: 18px;" id="npm-scripts-for-linting-files-and-unit-testing">
<b>NPM Scripts for Linting Files and Unit Testing</b>
Expand Down

0 comments on commit bc83198

Please sign in to comment.