Vue 3 + i18n + Typescript + Vite + Storybook + TailwindCSS + ESLint + Prettier

This template should help get you started developing with Vue 3 and Typescript in Vite. The template uses Vue 3 <script setup> SFCs, check out the script setup docs to learn more.

Create stories with Typescript

You can write stories with JavaScript or Typescript alike as both your dev server and storybook server allow it. Start writing stories with this introduction

Add translations to locales files

Translations are ready to go with vue-i18 Add your files to /locales and are you are set.

ESLint

Change your config at .eslintrc.js

Prettier

Change config at .prettierrc

Scripts

npm install // installs packages
npm run vite // starts the dev server
npm run tailwind // starts the tailwind config preview server
npm run build // run build
npm run dev // preview build
npm run serve // preview build
npm run storybook // starts storybook
npm run lint // lint and fix all files
npm run format // run prettier on all files

(Local) Deployment

Copy example.env to .env and set version and IPs (for local nginx)

make build // build docker
make build-dev // build development docker
make build-storybook // build storybook docker
make serve-dev // serve development docker on given IP in .env
make serve-storybook // serve development docker on given IP in .env

Recommended IDE Setup

• VSCode + volar

Type Support For .vue Imports in TS

Since TypeScript cannot handle type information for .vue imports, they are shimmed to be a generic Vue component type by default. In most cases this is fine if you don't really care about component prop types outside of templates. However, if you wish to get actual prop types in .vue imports (for example to get props validation when using manual h(...) calls), you can enable Volar's .vue type support plugin by running Volar: Switch TS Plugin on/off from VSCode command palette.

Folder structure

.
├── LICENSE
├── README.md
├── index.html
├── package.json
├── public
│   ├── favicon.ico
│   ├── robots.txt
├── src
│   ├── App.vue
│   ├── assets
│   │   └── fonts
│   ├── components
│   ├── data
│   ├── locales
│   ├── views
│   ├── router.js
│   ├── i18n.js
│   ├── main.ts
│   ├── shims-vue.d.ts
│   ├── stories
│   │   ├── BasicButton.stories.ts
│   │   ├── BasicButton.vue
│   │   ├── Header.stories.js
│   │   ├── Header.vue
│   │   ├── Introduction.stories.mdx
│   │   ├── Page.stories.js
│   │   ├── Page.vue
│   │   ├── assets
│   │   │   ├── code-brackets.svg
│   │   │   ├── colors.svg
│   │   │   ├── comments.svg
│   │   │   ├── direction.svg
│   │   │   ├── flow.svg
│   │   │   ├── plugin.svg
│   │   │   ├── repo.svg
│   │   │   └── stackalt.svg
│   │   ├── header.css
│   │   └── page.css
│   ├── styles
│   │   ├── _colors.scss
│   │   ├── _font.scss
│   │   ├── _reset.scss
│   │   ├── boot.scss
│   │   └── functions
│   │       └── _color.scss
│   └── types
│       └── Size.ts
├── tsconfig.json
├── vite.config.ts
└── yarn.lock