Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/ElanYoung/vite-vue-js-starter-template

🚀 Vite5 + Vue3 + JavaScript Starter Template
https://github.com/ElanYoung/vite-vue-js-starter-template

pinia vite vue-router vue3

Last synced: about 1 month ago
JSON representation

🚀 Vite5 + Vue3 + JavaScript Starter Template

Lists

README

        

Vite 5 🚀 - Vue 3 Starter Template



node compatility


vite


vue


vue-router


pinia


author


LICENSE


Vite5 + Vue3 + JavaScript + Vue Router + Pinia + TDesign + Less + Axios + ESLint + Stylelint + Prettier


Live Demo


English | įŽ€äŊ“中文

## Features

+ ⚡ī¸ [Vite 5](https://github.com/vitejs/vite) - born with fastness
+ 🖖 [Vue 3](https://github.com/vuejs/core) - Composition API and ``
+ đŸšĻ [Vue Router](https://github.com/vuejs/router) - The official router for Vue.js.
+ đŸ“Ļ [Pinia](https://github.com/vuejs/pinia) - Intuitive, type safe and flexible Store for Vue
+ đŸ’ģ [TDesign](https://github.com/Tencent/tdesign-vue-next) - Vue Next for Web
+ 🎨 [Less](https://github.com/less/less.js) - It's CSS, with just a little more
+ đŸ“Ĩ [APIs auto importing](https://github.com/antfu/unplugin-auto-import) - Use Composition API and others directly
+ 😃 [Icons auto install](https://github.com/unplugin/unplugin-icons) - Access thousands of icons as components on-demand universally.
+ 🔗 [Axios](https://github.com/axios/axios) - Promise based HTTP client for the browser and node.js
+ 🧰 [Husky](https://typicode.github.io/husky/#/) + [Lint-Staged](https://github.com/okonet/lint-staged) - Git Hook Tools
+ 🛡ī¸ [EditorConfig](http://editorconfig.org) + [ESLint](http://eslint.org) + [Prettier](https://prettier.io) + [Stylelint](https://stylelint.io) - Code Standards
+ 🔨 [Commitizen](https://cz-git.qbb.sh/zh) + [Commitlint](https://commitlint.js.org) - Submit Standards

## Coding Style

+ Use Composition API with [`<script setup>` SFC syntax](https://github.com/vuejs/rfcs/pull/227)
+ [ESLint](https://eslint.org)
+ [Prettier](https://prettier.io)
+ [Stylelint](https://stylelint.io)

## Development Tools

+ [pnpm](https://pnpm.io/) - fast, disk space efficient package manager
+ [Visual Stuido Code Extensions](./.vscode/extensions.json)
+ [Vite](https://marketplace.visualstudio.com/items?itemName=antfu.vite) - Fire up Vite server automatically
+ [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) - Vue 3 `<script setup>` IDE support
+ [EditorConfig for VS Code](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig) - A solution for unifying code formats
+ [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) - Find and fix problems in your JavaScript code
+ [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) - An opinionated code formatter
+ [StyleLint](https://marketplace.visualstudio.com/items?itemName=stylelint.vscode-stylelint) - A mighty, modern linter that helps you avoid errors and enforce conventions in your styles.

## Try it now!

> Vite5 Vue3 JavaScript Starter Template requires Node >= 18.00

### GitHub Template

[Create a repo from this template on GitHub](https://github.com/ElanYoung/vite-vue-js-starter-template/generate).

### Clone to local

If you prefer to do it manually with the cleaner git history

```bash
# [optional] if you are using Windows, you need to close the end-of-line conversion
git config --global core.autocrlf input

# clone repository
git clone https://github.com/ElanYoung/vite-vue-js-starter-template

# open folder vite-vue-js-starter-template
cd vite-vue-js-starter-template

# install packages
npm i
```

## Checklist

When you use this template, try follow the checklist to update your info properly

- [ ] Change the author name in `LICENSE`
- [ ] Change the title in `App.vue`
- [ ] Change the hostname in `vite.config.js`
- [ ] Change the favicon in `public`
- [ ] Remove the `.github` folder which contains the funding info
- [ ] Clean up the READMEs and remove routes

## Usage

### Development

> Just run and visit http://localhost:3000

```bash
## install dependencies
npm install

## set up
npm run dev
```

### Build

```bash
## build
npm run build
```

## Achievement

🎉 Added to the [Awesome Vite.Js](https://github.com/vitejs/awesome-vite#vue-3)

## License

[MIT](http://opensource.org/licenses/MIT)

Copyright (c) 2022 ElanYoung