Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/recallwei/vue-ts-starter-template
đ An opinionated Vue 3/TypeScript starter template.
https://github.com/recallwei/vue-ts-starter-template
opinionated tailwindcss template typescript vite vue3
Last synced: 9 days ago
JSON representation
đ An opinionated Vue 3/TypeScript starter template.
- Host: GitHub
- URL: https://github.com/recallwei/vue-ts-starter-template
- Owner: recallwei
- License: mit
- Created: 2023-08-25T19:22:02.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-14T23:24:46.000Z (about 1 year ago)
- Last Synced: 2023-10-16T05:29:18.629Z (about 1 year ago)
- Topics: opinionated, tailwindcss, template, typescript, vite, vue3
- Language: TypeScript
- Homepage:
- Size: 580 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Vue Starter Template
English / [įŽäŊä¸æ](./README.zh-CN.md)
đ An opinionated Vue 3/TypeScript starter template.
## Features
- [x] Based on [Vue 3](https://vuejs.org/), [Vite](https://vitejs.dev/), [pnpm](https://pnpm.io/)
- [x] [TypeScript](https://www.typescriptlang.org/), of course
- [x] [Naive UI](https://www.naiveui.com/) as UI framework
- [x] [Tailwind CSS](https://tailwindcss.com/) for rapid development based on atomic CSS
- [x] [Sass](https://sass-lang.com/) for CSS pre-processing
- [x] [Vue Router](https://router.vuejs.org/) for routing management
- [x] [Pinia](https://pinia.esm.dev/) for global state management
- [x] [Axios](https://axios-http.com/) for request management
- [x] [iconify/json] and [unplugin-icons] for icon management, can use icones quickly
- [x] [unplugin-auto-import] and [unplugin-vue-components] for automatic import, free your hands
- [x] [ESLint](https://eslint.org/) for code checking
- [x] [Prettier](https://prettier.io/) for code formatting
- [x] [cspell] for code spell checking
- [x] [Husky](https://typicode.github.io/husky/#/) and [lint-staged] and [commitlint] for Git commit management
- [ ] [Docker](https://www.docker.com/) and [Docker Compose](https://docs.docker.com/compose/) for containerization
- [x] Use `@/*` as absolute path
- [x] Deploy on Vercel, zero config
## Tech Stack
- [Vue 3](https://vuejs.org/)
- [TypeScript](https://www.typescriptlang.org/)
- [Vite](https://vitejs.dev/)
- [Naive UI](https://www.naiveui.com/)
- [Sass](https://sass-lang.com/)
## Code Style
- [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript)
## Getting Started
### GitHub Template
> Vue Starter Template requires Node version >=14.16.0
[Create a repo using this template](https://github.com/recallwei/vue-starter-template/generate).
### Clone to local
If you prefer to do it manually with a cleaner Git history then follow these steps:
```bash
npx degit recallwei/vue-starter-template my-app
cd my-app
pnpm i
```
## Checklist
When using this template, try to update your own information correctly according to the checklist:
- [ ] Clean up `README.md`
- [ ] Change author name in `LICENSE`
- [ ] Change project name, description, author, etc. in `package.json`
- [ ] Modify environment variables in `.env` and delete the file `.env.example` which is an example of environment variables
- [ ] Modify the site meta data in `index.html`
- [ ] Change `favicon.ico` in the `/public` directory
- [ ] Change the interface proxy in `vite.config.ts`
- [ ] Change the site meta data in `src/app.config.ts`
- [ ] Delete the example API in the `src/api` directory
- [ ] Delete the example images in the `src/assets/images` directory
- [ ] Delete the example route in the `src/router` directory
- [ ] Delete the example view in the `src/views` directory
- [ ] Delete the example store in the `src/store` directory
## Notice
- xxx
## Usage
### Environment
- Node.js >=16.14.0
- pnpm
### Config Environment Variables
Config `.env` file, refer to [.env.example](./.env.example).
### Install
```bash
pnpm i
```
### Start
```bash
pnpm dev
```
### Build
```bash
pnpm build
```
## Known Issue
- [ ] xxx
## License
[MIT](/LICENSE) License Š 2023 [Bruce Song](https://github.com/recallwei)