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

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

## NPM Commands
## Bundle 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.
Recommendation is to install npm through `Node Version Manager`.

The watch command compiles the components then watches the files and recompiles when one of them changes.
The build command compiles the components then monitors the source files and triggers their recompilation when one of them is changed.

```shell
npm run watch
npm run build
```

After all updates are done, this command compiles the assets locally, minifies them and makes them ready for production.

```shell
npm run prod
```

## Running the application

We recommend running your applications in WSL:
Expand Down
1 change: 0 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
"main": "index.js",
"type": "module",
"scripts": {
"preview": "php -S 0.0.0.0:8080 -t public",
"build": "vite build --watch"
},
"repository": {
Expand Down
Loading