Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,27 +99,28 @@ composer development-enable

- If not already done, remove the `.dist` extension from `config/autoload/development.local.php.dist`.

## NPM Commands
## Bundling Static Modules

> Prerequisite software: Node.js v20 (minimum supported version)

To install dependencies into the `node_modules` directory run this command.

```shell
npm install
```

- If `npm install` fails, this could be caused by user permissions of npm. Recommendation is to install npm through `Node Version Manager`.
If `npm install` fails, this could be caused by user permissions of npm.
We recommend installing npm through `Node Version Manager`.

The watch command compiles the components then watches the files and recompiles when one of them changes.
> You can skip the next step until you make changes in the `src/App/assets` folder

```shell
npm run watch
```
The build command compiles the components from the `src/App/assets` folder into the `public` folder.

After all updates are done, this command compiles the assets locally, minifies them and makes them ready for production.
> This command overwrites existing files in the `public` folder.

```shell
npm run prod
```
npm run build
```

## Running the application

Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
"main": "index.js",
"type": "module",
"scripts": {
"preview": "php -S 0.0.0.0:8080 -t public",
"build": "vite build --watch"
"watch": "vite build --watch",
"build": "vite build"
},
"repository": {
"type": "git",
Expand Down
Loading