https://github.com/thecodeorigin/vue-template
A Vue 2 boilerplate for enterprises with best practice folder structure, tailwindcss configuration and many more 🚀🚀🚀
https://github.com/thecodeorigin/vue-template
enterprises vue-template
Last synced: 10 months ago
JSON representation
A Vue 2 boilerplate for enterprises with best practice folder structure, tailwindcss configuration and many more 🚀🚀🚀
- Host: GitHub
- URL: https://github.com/thecodeorigin/vue-template
- Owner: thecodeorigin
- License: mit
- Created: 2021-03-11T13:36:14.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-08-30T14:51:14.000Z (over 4 years ago)
- Last Synced: 2023-03-09T23:32:22.667Z (almost 3 years ago)
- Topics: enterprises, vue-template
- Language: JavaScript
- Homepage:
- Size: 1.13 MB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# vue-template
Inspired by vue-enterprise-template
See the [vue-enterprise-template repo](https://github.com/chrisvfritz/vue-enterprise-boilerplate)
## Project setup
``` bash
# Setup alias
node _start.js
npm install
# OR
yarn
```
### Compiles and hot-reloads for development
``` bash
npm run dev
# OR
yarn dev
```
### Compiles and minifies for production
``` bash
npm run build
# OR
yarn build
```
### Lints and fixes files
``` bash
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](https://nuxtjs.org) 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`