Skip to content

Commit a3d3fe4

Browse files
committed
docs: modernize README + CI for Node 24 / Vite / Capacitor (F.3)
- Remove obsolete Dockerfile + .dockerignore (Node 12 / mDNS / Spectron). - CI (main.yml, dist.yml): Node 24, npm ci, drop submodules/mDNS/python/npm-pin; run vitest (test:ci) and electron-vite build. - README: rewrite requirements, scripts, desktop/mobile dev, and structure for the new toolchain; drop Cordova/webpack/Jest/mDNS sections.
1 parent 7aa5027 commit a3d3fe4

5 files changed

Lines changed: 66 additions & 293 deletions

File tree

.dockerignore

Lines changed: 0 additions & 28 deletions
This file was deleted.

.github/workflows/dist.yml

Lines changed: 6 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -11,36 +11,16 @@ jobs:
1111
dist:
1212
runs-on: ubuntu-latest
1313
steps:
14-
- uses: actions/checkout@v3
15-
with:
16-
submodules: recursive
17-
# Set python version to 2.x due to node-gyp and sass
18-
- uses: actions/setup-python@v4
19-
with:
20-
python-version: "3.10.12"
21-
# Set node version
14+
- uses: actions/checkout@v4
2215
- uses: actions/setup-node@v4
2316
with:
24-
node-version: "14.21.3"
25-
- name: Set NPM 7
26-
run: npm install -g npm@8.19.4
27-
# Cache node_modules
28-
- uses: actions/cache@v4
29-
env:
30-
cache-name: cache-node-modules
31-
with:
32-
path: "**/node_modules"
33-
key: ${{ runner.os }}-modules-${{ hashFiles('**/package-lock.json') }}
34-
35-
- name: Install MDNS build dependencies
36-
run: |
37-
sudo apt-get update
38-
sudo apt-get install libavahi-compat-libdnssd-dev
17+
node-version: "24"
18+
cache: npm
3919

40-
- name: Install node modules
41-
run: npm install
20+
- name: Install dependencies
21+
run: npm ci
4222

43-
- name: Dist
23+
- name: Dist (Linux)
4424
run: npm run dist:linux -- --publish always
4525
env:
4626
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/main.yml

Lines changed: 14 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -11,73 +11,33 @@ jobs:
1111
test:
1212
runs-on: ubuntu-latest
1313
steps:
14-
- uses: actions/checkout@v3
15-
with:
16-
submodules: recursive
17-
# Set python version to 2.x due to node-gyp and sass
18-
- uses: actions/setup-python@v4
19-
with:
20-
python-version: "3.10.12"
21-
# Set node version
14+
- uses: actions/checkout@v4
2215
- uses: actions/setup-node@v4
2316
with:
24-
node-version: "14.21.3"
25-
- name: Set NPM 7
26-
run: npm install -g npm@8.19.4
27-
# Cache node_modules
28-
- uses: actions/cache@v4
29-
env:
30-
cache-name: cache-node-modules
31-
with:
32-
path: "**/node_modules"
33-
key: ${{ runner.os }}-modules-${{ hashFiles('**/package-lock.json') }}
34-
35-
- name: Install MDNS build dependencies
36-
run: |
37-
sudo apt-get update
38-
sudo apt-get install libavahi-compat-libdnssd-dev
17+
node-version: "24"
18+
cache: npm
3919

40-
- name: Install node modules
41-
run: npm install
20+
- name: Install dependencies
21+
run: npm ci
4222

4323
- name: Lint
4424
run: npm run lint -- --max-warnings 0 && npm run sass-lint -- --max-warnings 0
4525

46-
- name: Run tests
47-
run: npm run test
26+
- name: Test
27+
run: npm run test:ci
4828

4929
build:
5030
needs: test
5131
runs-on: ubuntu-latest
5232
steps:
53-
- uses: actions/checkout@v3
54-
with:
55-
submodules: recursive
56-
# Set python version to 2.x due to node-gyp and sass
57-
- uses: actions/setup-python@v4
58-
with:
59-
python-version: "3.10.12"
60-
# Set node version
33+
- uses: actions/checkout@v4
6134
- uses: actions/setup-node@v4
6235
with:
63-
node-version: "14.21.3"
64-
- name: Set NPM 7
65-
run: npm install -g npm@8.19.4
66-
# Cache node_modules
67-
- uses: actions/cache@v4
68-
env:
69-
cache-name: cache-node-modules
70-
with:
71-
path: "**/node_modules"
72-
key: ${{ runner.os }}-modules-${{ hashFiles('**/package-lock.json') }}
73-
74-
- name: Install MDNS build dependencies
75-
run: |
76-
sudo apt-get update
77-
sudo apt-get install libavahi-compat-libdnssd-dev
36+
node-version: "24"
37+
cache: npm
7838

79-
- name: Install node modules
80-
run: npm install
39+
- name: Install dependencies
40+
run: npm ci
8141

82-
- name: Build
83-
run: npm run build:electron
42+
- name: Build (Vite + Electron)
43+
run: npm run build

Dockerfile

Lines changed: 0 additions & 46 deletions
This file was deleted.

0 commit comments

Comments
 (0)