Kagura-Vue3-template

// TBD

English | 简体中文 | 日本語

Status

Coding

Overview

// TODO

Build Setup

// TODO

Build Production Mode

Build System

yarn build:prod

or

npm run build:prod

Build Documents

yarn docs:build

or

npm run docs:build

Documentation

// TODO

Screenshot

// TODO

Feature

// TODO

Use Library and Framework

Base

Vue 3: Base Framework

vue-router: Router

Pinia: Substitute Vuex

Vue-i18n: Multi Language Support

axios: AJAX Base

Typescript: Based for Code

Element-plus: UI Framework Base

less: CSS Style

Extends

nprogress: Progress Bar

vite-plugin-svg-icons: Used to generate svg sprite map

idb-keyval: A Simple Promise-Based key-val Store Implemented with IndexedDB

@miramiya/request: Axios Encapsulation Library

Preparation

You need to install Node and Git locally. The project is based on Typescript, Vue 3, Pinia, vue-router, axios and Element-plus. Understanding and learning these knowledge in advance will greatly help you on using this project.

Project Structure

├── public
│   │── favicon.ico
├── src
│   ├── api
│   ├── assets
│   ├── components
│   ├── config
│   ├── directives
│   ├── filters
│   ├── interface
│   ├── language
│   ├── layout
│   ├── router
│   ├── store
│   ├── style
│   ├── utils
│   ├── views
│   ├── App.tsx
│   ├── main.ts
│   ├── permission.ts
│   └── env.d.ts
│── .env.development
│── .env.production
│── .eslintrc.cjs
│── .prettierrc.json
│── index.html
│── package.json
│── README.md
│── README-ZH.md
│── README-JP.md
│── shims-vue.d.ts
│── tsconfig.json
│── vite.config.ts
│── yarn.lock

Browsers support

Modern Browsers

Attention: Not Support Internet Explorer

Edge	Firefox	Chrome	Safari
Edge	last 4 versions	last 4 versions	last 2 versions

License

MIT License