Andris Enins
91cd18aec6
Backend (Spring Boot 3.2 / Java 21 / PostgreSQL): - JWT auth with BCrypt password hashing - User profile + Mifflin-St Jeor BMR calculator - Food search + barcode via OpenFoodFacts API with local cache - Meal CRUD with user data isolation and ownership checks - AI photo analysis (OpenAI Vision) with confidence intervals - AI correction feedback loop for personalisation - Flyway DB migrations + RFC-7807 error responses Mobile (React Native / TypeScript): - Full navigation stack (Auth → Tabs → Home stack) - Design tokens (WCAG 2.2 AA colours, 8px grid, 48px touch targets) - 10 screens: Login, Register, Home, Search, Camera, AI Result, Edit Meal, Daily Details, History, Profile - Confidence-aware calorie display (kcal ± range) - Repeat last meal shortcut + macro tracking Docs: - docs/PLAN-AND-REQUIREMENTS.md - docs/traceability.csv (35 requirements, all Implemented)
52 lines
2.0 KiB
Markdown
52 lines
2.0 KiB
Markdown
# Virsaitis Usage Guide
|
|
|
|
## Quick Start
|
|
|
|
1. **Install the extension**: Sideload the `.vsix` file via Extensions → "..." → "Install from VSIX..."
|
|
2. **Open your project**: The extension activates on startup
|
|
3. **First run**: The Setup Wizard will guide you through initial configuration
|
|
|
|
## Daily Workflow
|
|
|
|
### Protected Files
|
|
Files in `.github/` are protected by governance rules. To edit them:
|
|
1. Open the Command Palette → "Virsaitis: Request Override"
|
|
2. Select the file, reason, and provide justification (min 20 chars)
|
|
3. The file becomes temporarily editable
|
|
|
|
### Secret Scanning
|
|
The extension automatically scans saved files for secrets and credentials.
|
|
If a secret is detected, the save is reverted and you'll see an error with line numbers.
|
|
|
|
### Status Bar
|
|
The shield icon in the status bar shows governance status:
|
|
- 🟢 **Active** — MCP server connected, enforcement active
|
|
- 🟡 **Reconnecting** — MCP server restarting
|
|
- 🔴 **Error** — MCP server failed (click for options)
|
|
- ⚪ **Disabled** — Governance enforcement turned off
|
|
|
|
### Commands
|
|
| Command | Description |
|
|
|---------|-------------|
|
|
| Install Governance Framework | Set up governance files in workspace |
|
|
| Validate Framework | Check installation completeness |
|
|
| Update Governance Framework | Update to latest bundled version |
|
|
| Configure MCP Server | Generate `.vscode/mcp.json` |
|
|
| Request Override | Temporarily unlock a protected file |
|
|
| Check Prerequisites | Verify Node.js ≥18 is installed |
|
|
| Run Setup Wizard | Re-run the initial setup flow |
|
|
| Restart MCP Server | Restart the governance validation server |
|
|
|
|
## Troubleshooting
|
|
|
|
### MCP Server won't start
|
|
1. Run "Virsaitis: Check Prerequisites" to verify Node.js ≥18
|
|
2. Check the Virsaitis output channel (View → Output → Virsaitis)
|
|
3. Try "Virsaitis: Restart MCP Server"
|
|
|
|
### Files are read-only unexpectedly
|
|
Protected governance files are intentionally read-only. Use "Request Override" to edit them.
|
|
|
|
### Extension not activating
|
|
Ensure `virsaitis.enabled` is `true` in your VS Code settings.
|