README.md

vue-template

Inspired by vue-enterprise-template See the vue-enterprise-template repo

Project setup

# Setup alias
node _start.js

npm install
# OR
yarn

Compiles and hot-reloads for development

npm run dev
# OR
yarn dev

Compiles and minifies for production

npm run build
# OR
yarn build

Lints and fixes files

npm run lint
# OR
yarn lint
# lint and fix
yarn lint --fix

Project structure

Project folders:

These are the folders that you will frequently change while doing the project

• components
• locales
• pages
• router
• services
• store
• styles

Core folder:

These are the common features, components, pages,... for the whole project

• api
• components
• constants
• layouts
• middleware
• mixins
• pages
• plugins
• styles
• utils

Code will be put in the core folder if create a new feature, a new module doesn't make change to that code

Conventions

Keep things clear, annotatable, highlightable by editor, be friendly with devTools

• Checkout Nuxt.js for more naming convention
• Use PascalCase for component name for better editor annotation and highlighting support
• Use camelCase for variables and functions
• Use export const instead of export default for auto import support
• Use My for custom component prefix, for example: MyCustomComponent
• Use my- for events prefix for better filtering in devTools, for example: my-blog-item-click