Baloise - Vue Starter Kit
(Vue 3 + Typescript + Vite)

This template should help get you started developing with Vue 3 and Typescript in Vite.

Plugins

• Component library: Baloise Design System
• Router: Vue Router
• State Management: Pinia
• Form Validation: VeeValidate
• Internationalization: Vue i18n
• Http client: Axios
• Testing: Vitest
• E2E Testing: Cypress
• Linting: ESlint
• Formatting: Prettier
• Documentation: Storybook

Recommended Utilities

• JavaScript utility library: Lodash
• JavaScript date library: date-fns

Recommended IDE Setup

• Install the IDE VSCode.
• Install all recommended extensions.

Recommended Documentations

• Vue 3
• Learing Platform: Vue Mastery

Getting started

To get stared clone the vue-starter-kit repository to you machine. Then navigate into the root folder of the project and install the npm dependencies.

git clone git@github.com:baloise/vue-starter-kit.git
cd vue-starter-kit
npm install

After setting up the project we can serve our application with:

npm run dev

The development sever runs at http://localhost:3000/.

NPM Scripts

install

Installs all the dependencies, which are listed in the package.json.

npm install

serve

Serves the application on the development server, which runs at http://localhost:3000/.

npm run dev

docs

Starts the local storybook server at http://localhost:6006/.

npm run docs

test

Unit

Run unit tests with vitest.

npm run test

# or run test with a watcher and a nice ui
npm run test:ui

End 2 End

Starts the development server and runs the cypress E2E test against it.

npm run test:e2e

build

Build the application for production release. The builded application will be in the dist folder.

npm run build

lint

Lints the whole src folder. Linting is also executed before the build.

npm run lint

format

With the help of the tool prettier we format all our source files.

npm run format

License

Apache-2.0 Licensed | Copyright © 2021-present Gery Hirschfeld & Contributors