Skip to content

Commit cdb10e4

Browse files
committed
feat: add folder starter and some file for starter
1 parent 53e6294 commit cdb10e4

19 files changed

Lines changed: 380 additions & 134 deletions

File tree

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# Vue 3 Enterprise Starter Template
22

33
![CI Quality](https://github.com/pharmacist-sabot/vue-starter/actions/workflows/ci.yml/badge.svg)
4-
[![License: MIT](httpsjq.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
54
[![Vue](https://img.shields.io/badge/Vue-3.5+-4FC08D?logo=vue.js)](https://vuejs.org/)
65
[![TypeScript](https://img.shields.io/badge/TypeScript-5.0+-3178C6?logo=typescript)](https://www.typescriptlang.org/)
76
[![Vite](https://img.shields.io/badge/Vite-6.0+-646CFF?logo=vite)](https://vitejs.dev/)
@@ -25,7 +24,7 @@ An opinionated, production-ready starter template for Vue 3 applications. Design
2524
- **Node.js:** version 22+ (LTS recommended)
2625
- **Package Manager:** PNPM (defined via `packageManager` in package.json)
2726

28-
## 📦 Getting Started
27+
## Getting Started
2928

3029
### 1. Clone the repository
3130

@@ -57,7 +56,7 @@ pnpm dev
5756

5857
The app will be served at `http://localhost:5173/`.
5958

60-
## nP📜 Available Scripts
59+
## Available Scripts
6160

6261
| Script | Description |
6362
| :---------------- | :------------------------------------------------------------- |
@@ -69,7 +68,7 @@ The app will be served at `http://localhost:5173/`.
6968
| `pnpm type-check` | Run TypeScript compiler check (no emit). |
7069
| `pnpm audit` | Check for high-severity security vulnerabilities. |
7170

72-
## fqDirectory Structure
71+
## Directory Structure
7372

7473
```text
7574
src/
@@ -84,7 +83,7 @@ src/
8483
└── views/ # Page components associated with routes
8584
```
8685

87-
## 🤝 Contribution Guidelines
86+
## Contribution Guidelines
8887

8988
### Commit Message Convention
9089

@@ -105,7 +104,7 @@ We follow the [Conventional Commits](https://www.conventionalcommits.org/) speci
105104
- `feature/*`: For new features (e.g., `feature/login-screen`).
106105
- `fix/*`: For bug fixes (e.g., `fix/header-alignment`).
107106

108-
## 🛡️ Quality Gates
107+
## Quality Gates
109108

110109
Before merging code, the following checks must pass (automated via GitHub Actions):
111110

@@ -114,6 +113,6 @@ Before merging code, the following checks must pass (automated via GitHub Action
114113
3. **Build:** The project must build successfully.
115114
4. **Audit:** No high-severity vulnerabilities.
116115

117-
## 📄 License
116+
## License
118117

119118
This project is licensed under the MIT License.

package.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,10 @@
1515
"audit": "audit-ci --high"
1616
},
1717
"dependencies": {
18-
"vue": "^3.5.24"
18+
"@vueuse/core": "^14.1.0",
19+
"pinia": "^3.0.4",
20+
"vue": "^3.5.24",
21+
"vue-router": "^4.6.3"
1922
},
2023
"devDependencies": {
2124
"@antfu/eslint-config": "^6.3.0",

0 commit comments

Comments
 (0)