vue-boilerplate-typescript
vue-boilerplate-typescript copied to clipboard
A Vue.js Boilerplate in Typescript w/ Vuex, Vue-Router, Element-UI, i18n, axios, Font-Awesome
Vue.js Boilerplate, Typescript, Vuex, Vue-Router, Element-UI, i18n, axios, Font Awesome
A typescript boilerplate for Vue.js with Vue CLI 3.x that uses:
- vuex
- vue-router
- Element-UI
- i18n
- axios
- Font Awesome
- ...
Requirements
- Node.js (npm)
Installation
-
Install Vue CLI 3.x
npm install -g @vue/cli # OR yarn global add @vue/cli
-
Install the dependencies
npm install # OR yarn install
Architecture
This is the way I personally structure Vue.js projects. Feel free to modify it to fit your needs.
- :file_folder:
assets
: Contains all assets such as images or sound files. - :file_folder:
components
: Contains allVue
components. - :file_folder:
layouts
: Contains allVue
-Layouts that can be set in thevue-router
. - :file_folder:
models
: Contains all models needed for the business logic. - :file_folder:
requests
: Contains all requests needed for communicating with the API. - :file_folder:
rules
: Contains all reusable validation rules. - :file_folder:
services
: Contains all services that fulfill web-requests. - :file_folder:
store
: Contains all modules that are being used by thevuex
-store. - :file_folder:
style
: Contains all stylesheets. - :file_folder:
translations
: Contains all translations as.ts
files. - :file_folder:
views
: Contains all views that are being used in thevue-router
.
Commands
Compiles and hot-reloads for development
npm run serve
# OR
yarn run serve
Compiles and minifies for production
npm run build
# OR
yarn run build
Lints and fixes files
npm run lint
# OR
yarn run lint