Vue 3 + TypeScript + Vite + Pinia + Vue i18n

The boilerplate of Vue v3, Typescript, Vite, Vue Router, Pinia, Axios, Tailwind CSS, and Vue i18n for buildings efficient, faster, maintainable, and scalable for enterprise applications.

1. Core Dependencies
2. Getting Started
   • Prerequisites
   • Installation

↑ Back to top

• Vue
• Vite
• Typescript
• Vue Router
• Vue i18n
• Vue Query
• Pinia
• Axios
• Tailwind CSS

VSCode + Volar (and disable Vetur) + TypeScript Vue Plugin (Volar).

TypeScript cannot handle type information for .vue imports by default, so we replace the tsc CLI with vue-tsc for type checking. In editors, we need TypeScript Vue Plugin (Volar) to make the TypeScript language service aware of .vue types.

If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a Take Over Mode that is more performant. You can enable it by the following steps:

1. Disable the built-in TypeScript Extension
   1. Run Extensions: Show Built-in Extensions from VSCode's command palette
   2. Find TypeScript and JavaScript Language Features, right click and select Disable (Workspace)
2. Reload the VSCode window by running Developer: Reload Window from the command palette.

See Vite Configuration Reference.

↑ Back to top

1. Node Js version v20.10.0. The current Long Term Support (LTS) release is an ideal starting point.

2. Visual Studio Code. Visual Studio Code is the free and open-sourced code editor. It is one of the top most editor used especially for JavaScript application development.

   Recommended Plugin for VSCode

   • TypeScript Vue Plugin (Volar)
   • Vue Language Features (Volar)
   • Tailwind CSS IntelliSense
   • Prettier - Code formatter
   • Prettier ESLint
   • Auto Rename Tag
   • Code Spell Checker
   • ESLint
   • Git Graph
   • GitLens — Git supercharged

↑ Back to top

1. Make sure you have a fresh version of Node.js and NPM installed.

2. Clone this repository to your computer:

   https://github.com/saymenghour/vue3-enterprise-boilerplate.git

3. Go to project directory:

   cd vue3-enterprise-boilerplate

4. Open project in VScode:

   code .

5. Run command below to ignore git case-sensitive filename

   git config --global core.ignorecase false

6. From the project's root directory, install the required packages (dependencies):

   using npm:

   npm install

   or using pnpm:

   pnpm install

7. Create environment files:

   cp .env.example .env

   or for local development using

   cp .env .env.local

8. Change its values appropriately

   BASE_API_URL="http://localhost:8080"

9. To run the app on your local machine:

   npm run dev

10. Build for production

    npm run build

Happy Coding... :)

MIT