https://github.com/kutia-software-company/vue3-starter

Starter project for Vue 3. Developed by Gentrit Abazi.
https://github.com/kutia-software-company/vue3-starter

vue-boilerplate vue-js vue-starter vue-typescript vue3 vue3-boilerplate vue3-starter

Last synced: 29 days ago
JSON representation

Starter project for Vue 3. Developed by Gentrit Abazi.

• Host: GitHub
• URL: https://github.com/kutia-software-company/vue3-starter
• Owner: kutia-software-company
• License: mit
• Created: 2021-06-07T12:18:44.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2021-06-13T12:20:10.000Z (over 4 years ago)
• Last Synced: 2025-04-18T00:56:36.492Z (6 months ago)
• Topics: vue-boilerplate, vue-js, vue-starter, vue-typescript, vue3, vue3-boilerplate, vue3-starter
• Language: TypeScript
• Homepage:
• Size: 532 KB
• Stars: 86
• Watchers: 4
• Forks: 17
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Vue 3 Starter

This is a starter project for [Vue Js](https://vuejs.org/).

The project is helpful to start your next project, as it provides a lot of the common tools you may reach for, all ready to go.

### Features

- TypeScript Included.

- Vue Router Included.

- Vuex.

- Bootstrap 5.

- Modules/Components organized across folders.

- Base pages (like Dashboard/404 etc).

- Pre-configured with code quality tools: Prettier, TypeScript, Jest, etc.

- Basic tests included.

- [Admin Kit](https://github.com/adminkit/adminkit) included.

- Class based components.

### Directory Structure

| Name                              | Description |

| --------------------------------- | ----------- |

| **build/**                        | Compiled source files will be placed here. |

| **public/**                       | Static assets (fonts, css, js, img). |

| **src/**                          | Source files. |

| **src/components**                | Vue components including shared (common) components. |

| **src/layouts**                   | Dynamic Layout Components. |

| **src/modules**                   | Views - screen components. |

| **src/routes**                    | Application routes. |

| **src/store**                     | Vuex state management. |

### Requirements

- [Node.js](https://nodejs.org/) v14 or newer.

### Installation

- Clone the repo - `git clone https://github.com/kutia-software-company/vue3-starter`.

- Install project dependencies — `npm install`.

- Create `.env` file - `cp .env.example .env`.

- Launch the app — `npm run dev`, it will become available at [http://localhost:3000](http://localhost:3000/).

### Available Scripts

- `dev`

- `build`

- `test:unit`

- `code:format`

- `code:check`

### Related Projects

- [Node.js TypeScript API Starter](https://github.com/kutia-software-company/express-typescript-starter).

- [React js TypeScript Starter](https://github.com/kutia-software-company/react-js-starter).

### License

[MIT](LICENSE).

---

Made with ♥ by Gentrit Abazi ([@gentritabazi01](https://github.com/gentritabazi01)).