Skip to content
Merged
Show file tree
Hide file tree
Changes from 4 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
13 changes: 4 additions & 9 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,21 +25,16 @@ jobs:
ref: ${{ inputs.commit_ref }}
persist-credentials: false # Don't persist GitHub token

- name: Cache node_modules
uses: actions/cache@v4
with:
path: node_modules/
key: node_modules-${{ runner.os }}-${{ hashFiles('yarn.lock') }}

- name: Install node.js
uses: actions/setup-node@v5
with:
node-version-file: '.nvmrc'
cache: 'npm'
cache-dependency-path: 'package-lock.json'

Comment thread
haslinghuis marked this conversation as resolved.
Comment thread
haslinghuis marked this conversation as resolved.
Comment thread
haslinghuis marked this conversation as resolved.
- run: npm install yarn -g
- run: yarn install
- run: npm ci
- name: Build
run: yarn build
run: npm run build
env:
DEBUG_BUILD: ${{ inputs.debug_build }}

Expand Down
2 changes: 0 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,3 @@ release/
# artefacts for Visual Studio Code
/.vscode/
npm-debug.log*
yarn-debug.log*
yarn-error.log*
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,20 +78,21 @@ just run:
nvm use
```

### Yarn
### npm

For dependency management we are using [yarn](https://yarnpkg.com/), follow the
instructions there to install it.
For dependency management we use [npm](https://www.npmjs.com/), which comes
bundled with Node.js.

### Development mode

We are using [vite](https://vitejs.dev/) for development setup. It provides
bundling and various optimisations like hot module reloading.

With `node` and `yarn` setup, to start developing run:
With `node` setup, first install dependencies, then start developing:

```bash
yarn start
npm install
npm start
Comment thread
haslinghuis marked this conversation as resolved.
```

This will start development server and the Blackbox will be available on http://localhost:5173/.
Expand All @@ -103,11 +104,11 @@ the tip of the repository:

First need to build the application:
```bash
yarn build
npm run build
```
Then start the application in `preview` mode
```bash
yarn preview
npm run preview
```
Visit http://localhost:4173/ and follow the steps from [Install the app to be used in offline mode](#install-the-app-to-be-used-in-offline-mode)

Expand Down
Loading
Loading