2025SELab2-project-Dwengo/frontend/README.md

1.9 KiB

dwengo-1-frontend

This template should help get you started developing with Vue 3 in Vite.

VSCode + Volar (and disable Vetur).

Webstorm should work out of the box.

Type Support for .vue Imports in TS

TypeScript cannot handle type information for .vue imports by default, so we replace the tsc CLI with vue-tsc for type checking. In editors, we need Volar to make the TypeScript language service aware of .vue types.

Customize configuration

See Vite Configuration Reference.

Project Setup

# Install dependencies
npm install

# Start necessary services for development
cd ../ # Go to the root of the repository
docker compose up -d
# Start the backend
cd backend
cp .env.development.example .env.development.local
npm run dev # or npm run build && npm run start

Compile and Hot-Reload for Development

npm run dev

Type-Check, Compile and Minify for Production

npm run build

Run Unit Tests with Vitest

npm run test:unit

Run End-to-End Tests with Playwright

cd frontend

# Install browsers for the first run
npx playwright install
# On Ubuntu, you can also use
npx playwright install --with-deps
# to additionally install the dependencies.

# When testing on CI, must build the project first
cd ..
npm run build
cd frontend

# Runs the end-to-end tests
npm run test:e2e
# Runs the tests only on Chromium
npm run test:e2e -- --project=chromium
# Runs the tests of a specific file
npm run test:e2e -- tests/example.spec.ts
# Runs the tests in debug mode
npm run test:e2e -- --debug

Lint with ESLint

npm run lint