-
-
Notifications
You must be signed in to change notification settings - Fork 15
Add automated tests, CI pipeline, and documentation improvements #30
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
b151a42
8695b5f
0dfed49
b0fafc4
7b744df
acd5d47
511a609
e2624ac
c5327b8
c22d666
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| name: Run Tests | ||
|
|
||
| on: | ||
| pull_request: | ||
| branches: [main] | ||
| push: | ||
| branches: [main] | ||
|
|
||
| jobs: | ||
| test: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: Checkout Code | ||
| uses: actions/checkout@v3 | ||
|
|
||
| - name: Setup Node.js | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: 22 | ||
|
|
||
| - name: Install Dependencies | ||
| working-directory: ./server | ||
| run: npm ci | ||
|
|
||
| - name: Run Tests | ||
| working-directory: ./server | ||
| run: npx vitest run | ||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -27,6 +27,7 @@ Transfer files across your local network directly from device to device using We | |||||
| - [2. Install Dependencies](#2-install-dependencies) | ||||||
| - [3. Run the Signaling Server](#3-run-the-signaling-server) | ||||||
| - [4. Serve the Frontend](#4-serve-the-frontend) | ||||||
| - [Running Tests](#running-tests) | ||||||
| - [Self-Hosting](#self-hosting) | ||||||
| - [Frontend — GitHub Pages](#frontend--github-pages) | ||||||
| - [Backend — Signaling Server](#backend--signaling-server) | ||||||
|
|
@@ -182,6 +183,31 @@ Then open `http://localhost:8080` in your browser. | |||||
|
|
||||||
| --- | ||||||
|
|
||||||
| ## Running Tests | ||||||
|
|
||||||
| ### Prerequisites | ||||||
|
|
||||||
| - Node.js 16+ and npm installed | ||||||
|
||||||
| - Node.js 16+ and npm installed | |
| - Node.js 20+ and npm installed |
Copilot
AI
Mar 21, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
README says Node.js 16+ and describes npm test as "watch mode", but server/package.json runs vitest run and the added devDependencies (vitest/vite) require a newer Node version. Please update the Node version requirement and adjust the command descriptions to match the actual scripts (or update scripts to match the docs).
Copilot
AI
Mar 24, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
README says "Or run the npm test script (watch mode)", but server/package.json defines npm test as vitest run (non-watch, single run). Adjust the wording (or the script) so the described behavior matches what actually runs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
GitHub Actions is using actions/checkout@v3. Consider bumping to actions/checkout@v4 to stay on the currently supported major version and receive the latest fixes.