84 lines
1.7 KiB
Markdown
84 lines
1.7 KiB
Markdown
# oxspeak-frontend
|
|
|
|
Scaffolded with Vuetify CLI.
|
|
|
|
## ❗️ Documentation
|
|
|
|
- Primary docs: https://vuetifyjs.com/
|
|
- Getting started guide: https://vuetifyjs.com/en/getting-started/installation/
|
|
- Community support: https://community.vuetifyjs.com/
|
|
- Issue tracker: https://issues.vuetifyjs.com/
|
|
|
|
## 🧱 Stack
|
|
|
|
- Framework: Vue 3 + Vite
|
|
- UI Library: Vuetify
|
|
- Language: TypeScript
|
|
- Package manager: yarn
|
|
|
|
## 🧭 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
|
|
- Vuetify MCP
|
|
- Pinia
|
|
- Vue I18n
|
|
- Vue Router
|
|
|
|
## 💿 Install
|
|
|
|
Use your selected package manager (yarn) to install dependencies:
|
|
|
|
```bash
|
|
yarn install
|
|
```
|
|
|
|
## 🚀 Quick Start
|
|
|
|
```bash
|
|
yarn install
|
|
yarn dev
|
|
```
|
|
|
|
## 🏗️ Build
|
|
|
|
```bash
|
|
yarn build
|
|
```
|
|
|
|
## 🧪 Available Scripts
|
|
|
|
- `yarn dev`
|
|
- `yarn build`
|
|
- `yarn preview`
|
|
- `yarn build-only`
|
|
- `yarn type-check`
|
|
- `yarn lint`
|
|
- `yarn lint:fix`
|
|
- `yarn mcp`
|
|
- `yarn mcp:revert`
|
|
|
|
## 💪 Support Vuetify Development
|
|
|
|
This project uses Vuetify - 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
|