|
| 1 | +# Vue Designer PrimeVue Tailwind CSS - Quick start template |
| 2 | + |
| 3 | +This is a starter template that pre-includes the [Pinegrow Vite Plugin](https://www.npmjs.com/package/@pinegrow/vite-plugin), [Pinegrow Tailwind CSS Plugin](https://www.npmjs.com/package/@pinegrow/tailwindcss-plugin) and other goodies for Vue Designer. |
| 4 | + |
| 5 | +Demo - https://pg-vue-primevue-tailwindcss.netlify.app/ |
| 6 | + |
| 7 | +## Vue Designer |
| 8 | + |
| 9 | +A desktop visual editor for Vue apps supporting Mac, Windows, and Linux by [Pinegrow](https://pinegrow.com/). Take it for a free trial at [Vue Designer](https://vuedesigner.com)! |
| 10 | + |
| 11 | +It lets you visually design 🎨 your Vue single file components and boosts your productivity and creativity while building your component-based Vue apps. |
| 12 | + |
| 13 | +It smartly integrates with your ⚡️ [Vite](https://vitejs.dev/) based CLI and provides an amazing developer experience with its powerful visual controls and features. |
| 14 | + |
| 15 | +Clean code 😃, No lock-in - You are in control of your projects and development workflow ❤️ |
| 16 | + |
| 17 | +## Try it now! |
| 18 | + |
| 19 | +### 1. Clone to local |
| 20 | + |
| 21 | +[Create a repo from this template on GitHub](https://github.com/pinegrow/pg-vue-primevue-tailwindcss/generate). |
| 22 | + |
| 23 | +(or) |
| 24 | + |
| 25 | +If you prefer to do it manually with the cleaner git history |
| 26 | + |
| 27 | +```bash |
| 28 | +npx giget@latest gh:pinegrow/pg-vue-primevue-tailwindcss my-vue-primevue-tailwindcss-app #project-name |
| 29 | +cd my-vue-primevue-tailwindcss-app |
| 30 | +npm install #or use pnpm |
| 31 | +``` |
| 32 | + |
| 33 | +(or) |
| 34 | + |
| 35 | +If you prefer a minimal template (a single empty home page) instead, |
| 36 | + |
| 37 | +```bash |
| 38 | +npx giget@latest gh:pinegrow/pg-vue-primevue-tailwindcss#minimal my-vue-primevue-tailwindcss-app #project-name |
| 39 | +cd my-vue-primevue-tailwindcss-app |
| 40 | +npm install #or use pnpm |
| 41 | +``` |
| 42 | + |
| 43 | +## 2. Open in Vue Designer |
| 44 | + |
| 45 | +Open your project in Vue Designer and follow the instructions displayed in the Config Panel (that should pop out automatically). Config Panel ⚙️ displays the key packages and the various links to their individual ecosystems and communities. |
| 46 | + |
| 47 | +## Usage |
| 48 | + |
| 49 | +### Start your development server |
| 50 | + |
| 51 | +```bash |
| 52 | +npm run dev |
| 53 | +``` |
| 54 | + |
| 55 | +### Build |
| 56 | + |
| 57 | +```bash |
| 58 | +npm run build |
| 59 | +``` |
| 60 | + |
| 61 | +### Analyze |
| 62 | + |
| 63 | +Uncomment the `rollup-plugin-visualizer` usage in your config file and execute the `build` command. This command will generate `stats.html`. Open `stats.html` in your browser to analyze bundle sizes. |
| 64 | + |
| 65 | +```bash |
| 66 | +npm run build # open stats.html to analyze bundle sizes |
| 67 | +``` |
| 68 | + |
| 69 | +### Preview |
| 70 | + |
| 71 | +```bash |
| 72 | +npm run now # build & preview |
| 73 | +``` |
| 74 | + |
| 75 | +### Lighthouse |
| 76 | + |
| 77 | +```bash |
| 78 | +npm run unlighthouse # Uses npx unlighthouse from https://unlighthouse.dev/ to run lighthouse on entire site (all pages) |
| 79 | +``` |
| 80 | + |
| 81 | +### Deploy to Netlify |
| 82 | + |
| 83 | +You can deploy this repo as a site on your own to explore and experiment with, by clicking this button. |
| 84 | +[](https://app.netlify.com/start/deploy?repository=https://github.com/Pinegrow/pg-vue-primevue-tailwindcss) |
| 85 | + |
| 86 | +Check out the [deployment documentation](https://vitejs.dev/guide/static-deploy.html#netlify) for more information. |
| 87 | + |
| 88 | +## Pre-packed |
| 89 | + |
| 90 | +### Meta Framework (Vue-based) |
| 91 | + |
| 92 | +- [Vite](https://vitejs.dev/) - Vite-powered Vue SPA |
| 93 | + - 👉 Follow the amazing Vue [docs](https://vuejs.org/guide/introduction.html) |
| 94 | + - 🚦 [Vue-Router](https://vuejs.org/guide/introduction.html) for client-side routing. Expressive, configurable, convenient enables snappy navigation. |
| 95 | + |
| 96 | +### UI Frameworks |
| 97 | + |
| 98 | +- [Tailwind CSS](https://tailwindcss.com/docs/guides/vite#vue) - The amazing utility-first CSS framework. |
| 99 | + |
| 100 | +### File-based CMS (markdown) |
| 101 | + |
| 102 | +- [unplugin-vue-markdown](https://github.com/mdit-vue/unplugin-vue-markdown) - file-based CMS powered by Markdown & Vue components. Note: This page is a markdown file 🗒. |
| 103 | + |
| 104 | +### Icons |
| 105 | + |
| 106 | +- [UnoCSS Preset Icons](https://github.com/unocss/unocss/tree/main/packages/preset-icons/) - use over 100,000 open-source [Iconify](https://iconify.design/) icons. Uses the **unocss** format for icon names, for example, `i-mdi-home`. |
| 107 | + |
| 108 | +### Modules/Plugins |
| 109 | + |
| 110 | +- [Pinegrow Vite Plugin](https://www.npmjs.com/package/@pinegrow/vite-plugin) - enables you to live-design your Vue single-file components visually in Vue Designer. |
| 111 | +- [Pinegrow Tailwind CSS Plugin](https://www.npmjs.com/package/@pinegrow/tailwindcss-plugin) - via Design Panel, enables visual controls customization (automatic) and theme customization (optional). |
| 112 | +- [unplugin-vue-router](https://github.com/posva/unplugin-vue-router) - Next-gen file based routing with type support for Vue Router. |
| 113 | +- [vite-plugin-vue-layouts](https://github.com/JohnCampionJr/vite-plugin-vue-layouts) - Router based layout for Vue applications using Vite. |
| 114 | +- 📲 [unplugin-vue-components](https://github.com/antfu/unplugin-vue-components) - On-demand components auto importing for Vue. |
| 115 | +- 📲 [unplugin-auto-import](https://github.com/antfu/unplugin-auto-import) - Auto import APIs on-demand for Vite, Webpack and Rollup. |
| 116 | +- [VueUse](https://vueuse.org/) - collection of essential Vue composition utilities. |
| 117 | +- 🍍 [Pinia](https://pinia.vuejs.org/) stores for global state management. Its light-weight, type-safe, extensible, modular with vue-devtools support. |
| 118 | +- [VeeValidate](https://vee-validate.logaretm.com/v4/) takes care of value tracking, validation, errors, submissions and more. |
| 119 | + |
| 120 | +### Devtools |
| 121 | + |
| 122 | +- [Vite Devtools](https://devtools-next.vuejs.org/guide/vite-plugin) - A Vite plugin for Vue that enhances your DX (developer experience) with an amazing set of in-app features. This is an in-app alternative to browser-based/standalone Vue Devtools. |
| 123 | +- [Vue Devtools](https://devtools.vuejs.org/guide/installation.html#standalone) - Official devtools that can be used as a standalone app alongside Vue Designer. It's conditionally configured in `main.ts` (only during development). |
| 124 | + - **ACTION REQUIRED**: Currently deactivated. In `main.ts`, uncomment the top devtools related snippet to activate. |
| 125 | + |
| 126 | +### VS Code Extensions |
| 127 | + |
| 128 | +- [VS Code Extensions](./.vscode/extensions.json) |
| 129 | + - [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) - Vue 3 `<script setup>` IDE support |
| 130 | + - [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) |
| 131 | + - [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) |
| 132 | + |
| 133 | +### Coding Style |
| 134 | + |
| 135 | +- Use Composition API with [`<script setup>` SFC syntax](https://vuejs.org/guide/scaling-up/sfc.html) |
| 136 | +- [ESLint](https://eslint.org) with [eslint-plugin-vue](https://vuejs.org/guide/scaling-up/tooling.html#linting) - official set of linting rules. |
| 137 | +- [Prettier](https://prettier.io) with [@vue/eslint-config-prettier](https://vuejs.org/guide/scaling-up/tooling.html#formatting) - format without conflicting with eslint rules. |
| 138 | + |
| 139 | +### Typescript |
| 140 | + |
| 141 | +This project allows JS, and strict mode is turned off. Update `tsconfig.ts` as required. |
| 142 | + |
| 143 | +```json |
| 144 | +{ |
| 145 | + "compilerOptions": { |
| 146 | + // ... |
| 147 | + "strict": false, |
| 148 | + "allowJs": true |
| 149 | + } |
| 150 | +} |
| 151 | +``` |
| 152 | + |
| 153 | +## Community |
| 154 | + |
| 155 | +- [Vue Designer Community](https://discord.gg/BYp45Nnu5T) |
0 commit comments