README.md

Vue 3 Starter

• Vue 3 + Vite 4 Minimalistic Starter Template
• Built with TypeScript 5 and Script Setup SFC
  
  

Features

• No complex || heavy dependencies
• Google Lighthouse Reports are 100% in green zone
• Atomic Design Pattern
• Configured public folder (icons, robots.txt, htaccess, humans.txt, etc)
• CSS normalization + SCSS Mixins & Maps
• Configured router (including transitions and navigation guards)
• Simple code examples for Storage, Composables, TypeScript, Modules
• ESLint 8 + Prettier 2 for better code quality
• Cypress + Vitest for testing

Preview

Live Demo

Engines

• Node.js: >= 18.14.2
• npm: >= 9.5.0

Recommended IDE

• VSCode + Volar

Installed Modules

• Pinia → Storage
• Axios → Promise based HTTP client
• VueUse → Best Collection of Vue Composition Utilities
• SASS → CSS Preprocessor
• ESLint + Prettier → linting and code formatting
• Cypress → End-to-End (e2e) testing framework
• Vitest → Unit testing framework
  
  

Scripts

Clone repo

git clone https://github.com/Demetory/dim-vue3-template

Install and update dependencies

npm install

Update deps if needed

npm update

Start the development server on http://localhost:5173

npm run dev

Build with type-check

npm run build

Build only

npm run build-only

Linting

npm run lint

npm run type-check

Unit Test

npm run test:unit

E2E Test

npm run test:e2e

License

MIT @demetory