Ecosyste.ms: Awesome

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

https://github.com/lecoueyl/vue3-template

Vue 3 starter template: Vite / Vue 3 / Tailwind CSS / PNPM
https://github.com/lecoueyl/vue3-template

github-pages github-pages-template netlify netlify-deployment pnpm starter-kit starter-template tailwind tailwindcss template vite vite-template vite-template-vue vue vuejs

Last synced: about 1 month ago
JSON representation

Vue 3 starter template: Vite / Vue 3 / Tailwind CSS / PNPM

Lists

README

        


Vue.js starter template

# Vue.js starter template

[![Open in Visual Studio Code](https://open.vscode.dev/badges/open-in-vscode.svg)](https://open.vscode.dev/lecoueyl/vue3-template)

Features:

- 🛠 [Vue 3](https://v3.vuejs.org/guide/introduction.html)
- ⚡️ [Vite](https://vitejs.dev/guide/)
- 🗂 [PNPM](https://pnpm.io)
- 🛣 [Vue Router](https://github.com/vuejs/vue-router-next)
- 🎨 [Tailwind CSS](https://tailwindcss.com/docs/)
- 🔍 [Eslint with airbnb and stylelint](https://github.com/airbnb/javascript)
- 🌗 [Light and dark mode composable](https://github.com/lecoueyl/vue3-template/blob/main/src/composables/theme.js)
- 🔡 [Inter var font](https://rsms.me/inter/)
- 📄 [Github pages action](https://pages.github.com)

## Getting Started

Scaffold this repository

```sh
pnpx degit lecoueyl/vue3-template my-project
cd my-project
```

Install and start dev server

```sh
pnpm install
pnpm run dev
```

## Deployment

### Netlify

[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/lecoueyl/vue3-template)

### Github pages

The default github action will build to `gh-page` when pushing on `main` branch.

For a project page, the base path of the repository must be specified. Add the following secret in the Github repository Settings > Secrets > Actions

| Name | Value |
| --------------------------- | ------------------------ |
| VITE_BASE_PUBLIC_PATH | `/repository-name/` |