wArchi

Frontend SPA for architectural modeling workflows: managing models, notations, visual styles, and versioned entities.

Русская версия: README.ru.md

Features

• Notation editor on top of Papirus canvas (selection, transforms, auto-layout)
• JSON import/export for notation data
• Component and relation style customization
• Custom node shapes with dedicated outline editor
• Tags, custom attributes, and relation rules editor
• Versioned models and notations
• Built-in documentation section (/docs) with guides, hotkeys, FAQ, and changelog
• Wiki section (/wiki) for entity-linked documentation pages
• Roles and feature grants: temporary admin role switch, hide node types in the model tree, duplicate report and merge
• Blue/green deployment support via Helm and deploy.sh

Tech Stack

• Vue 3 (<script setup>, Composition API)
• TypeScript (strict mode)
• Vite
• Vue Router 5
• Vitest

Requirements

• Node.js >=20.19.0 <21 || >=22.12.0 (enforced by engines and the prebuild check)
• npm 9+
• Papirus NPM package (@ngroznykh/papirus)

Quick Start

npm install
cp .env.example .env.local
npm run dev

App runs on http://localhost:5173 and proxies /api/* to backend.

NPM Scripts

Command	Description
npm run dev	Start dev server
npm run lint	Run ESLint
npm run lint:fix	Auto-fix lint issues
npm run build	Type-check and production build
npm run preview	Preview built app
npm run test	Run unit tests
npm run test:watch	Run unit tests in watch mode
npm run ci:local	Full quality gate (versions, lint, type-check, tests, build); same as GitHub Actions CI

Deployment (deploy.sh)

./scripts/deploy.sh supports two modes:

• Legacy: recreates release
• Blue/Green: deploys inactive color, verifies readiness, optionally switches traffic

Main environment flags:

Variable	Default	Purpose
NAMESPACE	arch	Kubernetes namespace
RELEASE_NAME	warchi	Helm release name
CHART_PATH	charts/warchi	Helm chart path
VALUES_FILE	charts/warchi/values.yaml	Values file
BUILD_IMAGE	true	Build Docker image before deploy
WAIT_TIMEOUT	180	Readiness timeout in seconds
INGRESS_HOST	warchi.local	Ingress host in output hints
IMAGE_TAG	""	Image tag override
BLUE_GREEN	false	Enable blue/green mode
BG_SWITCH	true	Switch traffic after green/blue verification
SERVICE_NAME	warchi	Service used to detect active color

Examples:

./scripts/deploy.sh
BUILD_IMAGE=false ./scripts/deploy.sh
BLUE_GREEN=true BG_SWITCH=true IMAGE_TAG=0.0.22 ./scripts/deploy.sh
BLUE_GREEN=true BG_SWITCH=false IMAGE_TAG=0.0.22 ./scripts/deploy.sh

Environment Variables

Configured via .env.local:

Variable	Default	Purpose
VITE_API_PROXY_TARGET	http://localhost:8080	Backend API URL
VITE_API_BASE_URL	empty	API base URL
VITE_API_VERSION	v1	API version
VITE_MODEL_LIVE_SYNC_MODE	hybrid	Model live sync mode: ws, poll, or hybrid (WebSocket + polling fallback)
VITE_MODEL_LIVE_POLL_MS	15000	Polling interval (ms) used in poll mode and as fallback in hybrid

Architecture Notes

• State management uses composables (no global store)
• API layer is based on typed ApiResult<T> wrappers
• Entities are versioned and grouped by name
• Notation editor uses Papirus rendering engine

Documentation

• In-app documentation section: /docs (overview, models, notations, diagrams, types, shapes, hotkeys, FAQ, changelog)
• Entity wiki section: /wiki (model, notation, type, and shape linked pages)
• Documentation content source: src/features/docs/content/*.md
• Technical plans and implementation notes: docs/*.md

Open Source Readiness

For public release preparation, see:

• CONTRIBUTING.md
• SECURITY.md
• CODE_OF_CONDUCT.md

License

This project is licensed under the MIT License.

Previously it was dual-licensed under AGPL-3.0-or-later with a commercial option; since 2026-09-24 the project is MIT.

See:

• LICENSE
• Licensing questions: nikolay@groznykh.ru