faro/frontend/README.md

frontend

Scaffolded with Vuetify CLI.

❗️ Documentation

• Primary docs: https://0.vuetifyjs.com/
• Getting started guide: https://0.vuetifyjs.com/guide
• Community support: https://community.vuetifyjs.com/
• Issue tracker: https://issues.vuetifyjs.com/

🧱 Stack

• Framework: Vue 3 + Vite
• UI Library: Vuetify0
• Language: TypeScript
• Package manager: npm

🧭 Start Here

• Main entry: src/main.ts
• Main app component: src/App.vue
• Main styles: src/styles/
• Plugin setup: src/plugins/

📁 Project Structure

• src/main.ts — application entry point
• src/App.vue — root component
• src/components/ — reusable Vue components
• src/plugins/ — plugin registration and setup
• src/styles/ — global styles and theme settings
• public/ — static public files

✨ Enabled Features

• ESLint
• Pinia
• Vue I18n
• Vuetify MCP
• Vue Router
• UnoCSS

💿 Install

Use your selected package manager (npm) to install dependencies:

npm install

🚀 Quick Start

npm install
npm run dev

🏗️ Build

npm run build

🧪 Available Scripts

• npm run dev
• npm run build
• npm run preview
• npm run build-only
• npm run type-check
• npm run lint
• npm run lint:fix

🤖 Vuetify MCP Server

This project is configured with the Vuetify Model Context Protocol (MCP) server. To install and configure the MCP server for your favorite IDE (Cursor, Trae, Windsurf, VS Code, Claude Desktop, etc.) run:

npx -y @vuetify/mcp-cli

This will open an interactive setup wizard to help you connect your AI assistant to the Vuetify ecosystem.

💪 Support Vuetify Development

This project uses Vuetify0 - an MIT licensed Open Source project. We are glad to welcome contributors and any support for ongoing development:

• Contribute to Vuetify and ecosystem projects: https://github.com/vuetifyjs
• Request enterprise support: https://support.vuetifyjs.com/
• Sponsor on GitHub: https://github.com/sponsors/vuetifyjs
• Support on Open Collective: https://opencollective.com/vuetify