https://github.com/hercules2013/vue3-ts-vite-starter

Vue 3 Boilerplate
https://github.com/hercules2013/vue3-ts-vite-starter

docker scss tailwindcss typescript vite vue3 vuejs

Last synced: about 2 months ago
JSON representation

Vue 3 Boilerplate

• Host: GitHub
• URL: https://github.com/hercules2013/vue3-ts-vite-starter
• Owner: Hercules2013
• Created: 2023-09-19T08:09:13.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-09-19T08:19:56.000Z (over 1 year ago)
• Last Synced: 2024-04-17T06:15:29.025Z (9 months ago)
• Topics: docker, scss, tailwindcss, typescript, vite, vue3, vuejs
• Language: Vue
• Homepage: https://vue3-vite-ts-boilerplate.vercel.app/
• Size: 1.39 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Vue 3 Boilerplate - TypeScript, Tailwind CSS, Vite, Pinia, Vue Query, Docker, Vite Pages  and DummyJSON

[Demo Link](https://vue3-vite-ts-boilerplate.vercel.app)

🚀 Vue 3 Boilerplate - TypeScript, Tailwind CSS, Vite, Pinia, Vue Query, Docker, Vite Pages  and DummyJSON ⚡️ Made with developer experience first: ESLint, Prettier, Husky, Lint-Staged, Jest, Testing Library, Commit Lint, VSCode, PostCSS

- 🚀 Sign In, Categories Page, Product Page

- ⚡ All configuration for api calling (using axios)

- ⚡ All configuration for routing, included guards

- 💎 Using docker for multiple env

- 🎁 Tailwind Css combine with Scss

- 🔥 Type checking [TypeScript](https://www.typescriptlang.org)

- 🎉 Storybook for UI development

- 🗂 VSCode configuration: Debug, Settings, Tasks and extension for PostCSS, ESLint, Prettier, TypeScript, Jest

- 🦊 Husky for Git Hooks

- 🚓 Friendly structure

- 🚫 Lint-staged for running linters on Git staged files

- 💡 Absolute Imports using @ prefix

- 🎁 Auto generate route in pages folder, same as Nextjs and Nuxtjs

- 📏 Linter with ESLint for Vue, Typescript

- 🚀 Implemented authentication

- 💡 Axios interceptors

This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue 3 `` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.

## Recommended IDE Setup

- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.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 Take Over mode by following these steps:

1. Run `Extensions: Show Built-in Extensions` from VS Code's command palette, look for `TypeScript and JavaScript Language Features`, then right click and select `Disable (Workspace)`. By default, Take Over mode will enable itself if the default TypeScript extension is disabled.

2. Reload the VS Code window by running `Developer: Reload Window` from the command palette.

You can learn more about Take Over mode [here](https://github.com/johnsoncodehk/volar/discussions/471).

## Build app with Docker compose

- To build `PRODUCTION`

  - Run `make build-production`

  - To start app `make start-production`

  - To stop container `make stop-production`

- To build `QA - For testing env`

  - Run `make build-qa`

  - To start app `make start-qa`

  - To stop container `make stop-qa`