shamscorner / vue-3-stackter

A Vue3 starter project setup with Vite, Vue-meta, Router, Pinia, Eslint, Prettier, Tailwind CSS, and some custom preferences. Also, there is a TypeScript branch of this same setup.

vue-3-stackter

A Vue3 starter project setup with these following components,

• Vite
• vue-meta-3.0.0-alpha.8
• Router
• Pinia (Vue 3 default)
• Eslint
• Prettier
• Tailwind CSS
• File based routing with vite-plugin-pages. (Like Nuxt file system routing)
• Layout system with vite-plugin-vue-layouts. (Like Nuxt layouts)
• Components auto importing with unplugin-vue-components
• ~/ alias for /src. So we don't have to write something like ../../../SomeModule to import modules.
• and some custom setups.

Check out Typescript version here

Check out Nuxt 3 starter template

Run this project:

yarn
yarn dev

Change site name

In App.vue change the following,

const siteName = 'Vite App' // add your site name here

Layouts

You can add layouts in your project if you want. You will find default.vue and 404.vue layout examples in this project. For more details, check out vite-plugin-vue-layouts. (Like Nuxt layouts system).

Pages

You can add pages to your project. You will find some example pages in the pages directory (index.vue, about/[name].vue, and [...all].vue). For more details, check out vite-plugin-pages. (Like Nuxt file system routing).

Meta info

You can add meta information in your pages. Here is an example,

<script setup>
import { useMeta } from 'vue-meta'

useMeta({
    title: 'Homepage',
})
...

</script>

Recommended IDE Setup

VSCode + Volar. Make sure to:

• Disable Vetur for the current workspace
• Disable built in TypeScript and JavaScript Language Features for the current workspace to enable take-over mode.

vue-3-stackter's Issues

Error in Typescript build

Any idea to resolve this

How to dynamically configure the content of meta tags

Hello, I am doing a similar requirement recently. Using vue3+setup+vue-meta, I found that there is no API to refer to. I can ask you how to dynamically modify the content of the meta tag in <script setup>. thanks

N00b Question .... re <main> tag

Hi Sham,

Thanks for a great Starter for Vue3, I'm going to be using it (hopefully) for my new site :D

I've made a few alterations to the code, to start my own design, but the content is locked to the very middle of the page because of the generated line

<main class="max-w-5xl p-5 mx-auto my-10 text-center">

Can you please advise how to modify it?

Thanks :D

Adding tailwind-config-viewer ?

Thanks for your template starter,
It'will be perfect for front app with tailwind-config-viewer,
If I had time I'll open a pull request for that :
https://github.com/rogden/tailwind-config-viewer

Valère