-
Notifications
You must be signed in to change notification settings - Fork 2
Frontend Setup
This guide covers local setup, configuration, and developer workflows for the Vue 3 single-page application (frontend/).
- Node.js: Version 22 LTS or 24 LTS.
- npm: Version 10+.
- VS Code (recommended editor).
In the frontend/ directory, create a .env file containing:
# URL of the Spring Boot backend API
VITE_BACKEND_URL=http://localhost:8080
# URL of the Vite dev server (used for CORS and redirect resolution)
VITE_FRONTEND_URL=http://localhost:3000
# Application environment identifier
VITE_NODE_ENV=openshift-dev
# Coverage instrumentation during dev/build
VITE_COVERAGE=true
# Optional JSON-stringified feature flags (e.g. enable multiple address entries)
VITE_FEATURE_FLAGS={"BCEID_MULTI_ADDRESS":true}When running the full stack with local Docker databases and the Spring Boot backend:
cd frontend
npm install
npm startThe application starts at http://localhost:3000.
If you are developing UI components, refining forms, or working on styling without running backend containers, you can use the built-in WireMock stub server:
cd frontend
# Starts both the WireMock stubs and the Vite development server
npm run preview
# Or run the WireMock stub server independently in a dedicated terminal
npm run stubWireMock responses are located in frontend/stub/. You can add or modify simulated JSON responses using WireMock response templating.
To ensure consistency with team styling standards:
- Vue - Official (Volar): High-performance language support for Vue 3 SFCs.
- Prettier - Code Formatter: Automatic code formatting.
- ESLint: Real-time lint feedback.
{
"editor.tabSize": 2,
"editor.formatOnSave": true,
"editor.defaultFormatter": "esbenp.prettier-vscode",
"[vue]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
}
}| Script | Command | Description |
|---|---|---|
npm start |
vite --host --port 3000 |
Starts local Vite development server with HMR. |
npm run test:unit |
vitest run --coverage |
Executes all frontend unit tests and generates coverage report. |
npm run coverage |
test:unit + component + e2e |
Executes unit, component, and E2E tests with merged coverage. |
npm run build |
vue-tsc && vite build |
Type-checks and bundles the production asset distribution into dist/. |
npm run stub |
wiremock --port 8080 ... |
Starts the local WireMock backend API mock server. |
npm run preview |
start-server-and-test ... |
Starts WireMock stubs and the Vite development server. |
This wiki serves as the central documentation and knowledge base for the Forests Client Management System, maintained by the British Columbia Ministry of Forests.
Please Note:
- This wiki is a living document maintained by the development team and contributors.
- When making substantial architectural or code changes, remember to update the corresponding wiki documentation.
- Always verify critical environment configurations against team vaults and OpenShift secret managers.
Have questions, found a documentation discrepancy, or need clarification?
- Questions or Bug Reports: Open an issue in the GitHub repository
- Pull Requests: Submit code or doc improvements via Pull Requests
- Database Schema Reference: Explore our SchemaSpy ER Diagrams
Forest Client Wiki | GitHub Repository
- Architecture Overview
- Frontend Architecture
- Frontend Structure
- Backend Architecture
- Backend Structure
- Legacy Architecture
- Processor Architecture
- Data Model
- Development Overview
- Local Setup & Docker
- Frontend Setup
- Backend Setup
- Project Conventions
- Frontend Structure Guidelines