Skip to content

TESTING.md

Latest commit

 

History

History
152 lines (105 loc) · 2.62 KB

TESTING.md

File metadata and controls

152 lines (105 loc) · 2.62 KB

Neptune GUI – Testing guide

This project is a Vue 2 + Vuetify web app. It supports local development, unit tests, and E2E tests.

Requirements

  • Node.js 14+ (16 or 18 recommended)
  • npm or yarn

Install Node.js (if needed):

# Ubuntu/Debian
sudo apt update && sudo apt install nodejs npm

# Or use nvm (recommended)
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash
nvm install 18
nvm use 18

Local demo with Neptune_2026

To run the UI with the real backend for a local demo:

  1. Start Neptune_2026 so that:
  2. In this repo run: 
    npm install
npm run dev
  3. Open http://localhost:8081 in the browser.

The dev server is fixed to port 8081 and proxies /api to the backend (8080) and /socket.io to port 3000. If your backend uses different ports, update vue.config.js devServer.proxy.

1. Install dependencies

# From project root
npm install
# or
yarn install

2. Run the app (development)

Start the dev server and open the browser:

npm run dev
# or
yarn dev

Or start without opening the browser:

npm run serve
# or
yarn serve

App URL: http://localhost:8081

  • / — Landing
  • /login — Login
  • /register — Register
  • /dashboard — Dashboard (requires login)
  • /editor — Editor

3. Production build

npm run build
# or
yarn build

Output is in dist/, ready for static hosting or deployment (e.g. Vercel via now.json).

4. Unit tests (Jest)

npm run test:unit
# or
yarn test:unit

Tests live in tests/unit/ (*.spec.js).

5. E2E tests (Cypress)

Start the dev server in one terminal:

npm run serve

Then run E2E in another:

npm run test:e2e
# or
yarn test:e2e

Cypress will open; run the specs under tests/e2e/specs/.

6. Lint (ESLint)

npm run lint
# or
yarn lint

Quick test flow (recommended)

npm install
npm run dev
# Open http://localhost:8081 and click through: Landing, Login, Register, Dashboard, etc.

# Optional:
npm run test:unit
# E2E: run "npm run serve" first, then "npm run test:e2e"

Notes

  • Dev proxy: vue.config.js devServer.proxy sends /api to http://localhost:8080 and /socket.io to http://localhost:3000. Change these if Neptune_2026 uses other ports.
  • Tests: Example E2E/unit tests target Neptune pages (e.g. #login, Neptune logo). Adjust tests/e2e/specs/test.js and tests/unit/example.spec.js if the UI changes.