Skip to content

Latest commit

 

History

History
63 lines (45 loc) · 2.03 KB

README.md

File metadata and controls

63 lines (45 loc) · 2.03 KB
Raw

Vue 3 Starter

This is a starter project for Vue Js.

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 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

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.

Available Scripts

  • dev
  • build
  • test:unit
  • code:format
  • code:check

Related Projects

License

MIT.

Made with ♥ by Gentrit Abazi (@gentritabazi01).