Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/boussadjra/vueye

Vue 3 template with many components based on Tailwind CSS 3 and Typescript
https://github.com/boussadjra/vueye

tailwindcss typescript vite vitejs vue vue3 vuejs vuejs3

Last synced: 27 days ago
JSON representation

Vue 3 template with many components based on Tailwind CSS 3 and Typescript

Host: GitHub
URL: https://github.com/boussadjra/vueye
Owner: boussadjra
License: mit
Created: 2021-01-13T22:40:00.000Z (almost 4 years ago)
Default Branch: main
Last Pushed: 2023-07-30T17:14:42.000Z (over 1 year ago)
Last Synced: 2024-11-20T02:36:24.135Z (about 1 month ago)
Topics: tailwindcss, typescript, vite, vitejs, vue, vue3, vuejs, vuejs3
Language: Vue
Homepage: https://vueye.vercel.app/
Size: 2.94 MB
Stars: 109
Watchers: 4
Forks: 12
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-vue-3 - vite-wind - Boilerplate with Tailwind CSS, TypeScript, css-pro-layout, 9+ components and dark mode support. (Examples)

README

        # Vueye : 

Is a Vue.js 3 template starter with many components styled using Tailwind CSS and built using Vitejs.

## Features

- ⚡️ [Vue 3](https://github.com/vuejs/vue-next), [Vite 2](https://github.com/vitejs/vite), [pnpm](https://pnpm.js.org/), [ESBuild](https://github.com/evanw/esbuild) - born with fastness

- 🗂 [File based routing](./src/pages)

- 📦 [Components auto importing](./src/components)

- 🍍 [State Management via Pinia](https://pinia.esm.dev/)

- 📑 [Layout system](./src/layouts)

- 📲 [PWA](https://github.com/antfu/vite-plugin-pwa)

- 🎨 [UnoCSS](https://github.com/antfu/unocss) - the instant on-demand atomic CSS engine

- 😃 [Use icons from any icon sets with classes](https://github.com/antfu/unocss/tree/main/packages/preset-icons)

- 🌍 [I18n ready](./locales)

- 🗒 [Markdown Support](https://github.com/antfu/vite-plugin-md)

- 🔥 Use the [new `` syntax](https://github.com/vuejs/rfcs/pull/227)

- 🤙🏻 [Reactivity Transform](https://vuejs.org/guide/extras/reactivity-transform.html) enabled

- 📥 [APIs auto importing](https://github.com/antfu/unplugin-auto-import) - use Composition API and others directly

- 🖨 Static-site generation (SSG) via [vite-ssg](https://github.com/antfu/vite-ssg)

- 🦔 Critical CSS via [critters](https://github.com/GoogleChromeLabs/critters)

- 🦾 TypeScript, of course

- ⚙️ Unit Testing with [Vitest](https://github.com/vitest-dev/vitest), E2E Testing with [Cypress](https://cypress.io/) on [GitHub Actions](https://github.com/features/actions)

- ☁️ Deploy on Netlify, zero-config

<br>

## Pre-packed

### UI Frameworks

- [UnoCSS](https://github.com/antfu/unocss) - The instant on-demand atomic CSS engine.

### Icons

- [Iconify](https://iconify.design) - use icons from any icon sets [🔍Icônes](https://icones.netlify.app/)

- [Pure CSS Icons via UnoCSS](https://github.com/antfu/unocss/tree/main/packages/preset-icons)

### Plugins

- [Vue Router](https://github.com/vuejs/vue-router)

  - [`vite-plugin-pages`](https://github.com/hannoeru/vite-plugin-pages) - file system based routing

  - [`vite-plugin-vue-layouts`](https://github.com/JohnCampionJr/vite-plugin-vue-layouts) - layouts for pages

- [Pinia](https://pinia.esm.dev) - Intuitive, type safe, light and flexible Store for Vue using the composition api

- [`unplugin-vue-components`](https://github.com/antfu/unplugin-vue-components) - components auto import

- [`unplugin-auto-import`](https://github.com/antfu/unplugin-auto-import) - Directly use Vue Composition API and others without importing

- [`vite-plugin-pwa`](https://github.com/antfu/vite-plugin-pwa) - PWA

- [`vite-plugin-md`](https://github.com/antfu/vite-plugin-md) - Markdown as components / components in Markdown

  - [`markdown-it-prism`](https://github.com/jGleitz/markdown-it-prism) - [Prism](https://prismjs.com/) for syntax highlighting

  - [`prism-theme-vars`](https://github.com/antfu/prism-theme-vars) - customizable Prism.js theme using CSS variables

- [Vue I18n](https://github.com/intlify/vue-i18n-next) - Internationalization

  - [`vite-plugin-vue-i18n`](https://github.com/intlify/vite-plugin-vue-i18n) - Vite plugin for Vue I18n

- [VueUse](https://github.com/antfu/vueuse) - collection of useful composition APIs

- [`vite-ssg-sitemap`](https://github.com/jbaubree/vite-ssg-sitemap) - Sitemap generator

- [`@vueuse/head`](https://github.com/vueuse/head) - manipulate document head reactively

### Coding Style

- Use Composition API with [`<script setup>` SFC syntax](https://github.com/vuejs/rfcs/pull/227)

- [ESLint](https://eslint.org/) with [@antfu/eslint-config](https://github.com/antfu/eslint-config), single quotes, no semi.

### Dev tools

- [TypeScript](https://www.typescriptlang.org/)

- [Vitest](https://github.com/vitest-dev/vitest) - Unit testing powered by Vite

- [Cypress](https://cypress.io/) - E2E testing

- [pnpm](https://pnpm.js.org/) - fast, disk space efficient package manager

- [`vite-ssg`](https://github.com/antfu/vite-ssg) - Static-site generation

  - [critters](https://github.com/GoogleChromeLabs/critters) - Critical CSS

- [Netlify](https://www.netlify.com/) - zero-config deployment

- [VS 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=johnsoncodehk.volar) - Vue 3 `<script setup>` IDE support

  - [Iconify IntelliSense](https://marketplace.visualstudio.com/items?itemName=antfu.iconify) - Icon inline display and autocomplete

  - [i18n Ally](https://marketplace.visualstudio.com/items?itemName=lokalise.i18n-ally) - All in one i18n support

  - [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)

## Try it now!

> This template is based on [vitesse](https://github.com/antfu/vitesse) and it requires Node >=14

### GitHub Template

[Create a repo from this template on GitHub](https://github.com/boussadjra/vueye/generate).

### Clone to local

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

```bash

npx degit boussadjra/vueye my-app

cd my-app

pnpm i # If you don't have pnpm installed, run: npm install -g pnpm

```

## Usage

### Development

Just run and visit http://localhost:3333

```bash

pnpm dev

```

### Build

To build the App, run

```bash

pnpm build

```

And you will see the generated file in `dist` that ready to be served.

### Deploy on Netlify

Go to [Netlify](https://app.netlify.com/start) and select your clone, `OK` along the way, and your App will be live in a minute.