https://github.com/web-dev-sam/vue-ts-tailwind-sam
A stricter Vue3 + TypeScript + TailwindCSS project template for more complex team-based vue apps.
https://github.com/web-dev-sam/vue-ts-tailwind-sam
Last synced: 3 months ago
JSON representation
A stricter Vue3 + TypeScript + TailwindCSS project template for more complex team-based vue apps.
- Host: GitHub
- URL: https://github.com/web-dev-sam/vue-ts-tailwind-sam
- Owner: web-dev-sam
- Created: 2024-03-04T16:43:39.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-04T16:44:09.000Z (about 2 years ago)
- Last Synced: 2025-02-27T19:33:39.482Z (about 1 year ago)
- Language: Vue
- Homepage:
- Size: 91.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# vue-ts-tailwind-sam
This is a stricter Vue3 + TypeScript + TailwindCSS project template for more complex team-based vue apps.
## IDE Setup
- Install recommended extensions
- Run `npm install` to install dependencies
- Start coding like you used to... _(Hint: `npm run dev`)_
## Features
- Vue3 with Composition API
- Pinia for state management
- Vue Router
- @/\* alias for src/
- Auto import only for commonly used vue helpers (like `ref`, `computed`, `watch`, etc.)
- TypeScript 5
- TailwindCSS (With Automatic Class Sorting)
- ESLint with Prettier
- Vitest for unit tests
- Cypress for e2e tests
- Husky for pre-commit checks
- Auto actions before commit
- Formatting staged files
- Fixing fixable ESLint errors in staged files
- Checks before commit _(Commit fails if any of these checks fail)_
- Type checking with TypeScript
- Linting staged files with ESLint
## Project Setup
```sh
npm install
npm run dev
npm run build
```
### Run Unit Tests with [Vitest](https://vitest.dev/)
```sh
npm run test:unit
```
### Run End-to-End Tests with [Cypress](https://www.cypress.io/)
```sh
npm run test:e2e:dev
```
This runs the end-to-end tests against the Vite development server.
It is much faster than the production build.
But it's still recommended to test the production build with `test:e2e` before deploying (e.g. in CI environments):
```sh
npm run build
npm run test:e2e
```