Skip to content

Commit 62850f2

Browse files
committed
Added PrimeVue Tailwind Setup
0 parents  commit 62850f2

File tree

169 files changed

+27851
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

169 files changed

+27851
-0
lines changed

.eslintrc.cjs

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
/* eslint-env node */
2+
require('@rushstack/eslint-patch/modern-module-resolution')
3+
4+
module.exports = {
5+
root: true,
6+
env: {
7+
node: true,
8+
},
9+
extends: [
10+
'plugin:vue/vue3-essential',
11+
'eslint:recommended',
12+
'@vue/eslint-config-typescript',
13+
'@vue/eslint-config-prettier/skip-formatting',
14+
],
15+
overrides: [
16+
{
17+
// These pages are not used directly by users so they can have one-word names.
18+
files: [
19+
'**/pages/**/*.{js,ts,vue}',
20+
'**/layouts/**/*.{js,ts,vue}',
21+
'**/app.{js,ts,vue}',
22+
'**/error.{js,ts,vue}',
23+
],
24+
rules: { 'vue/multi-word-component-names': 'off' },
25+
},
26+
],
27+
rules: {
28+
// override/add rules settings here, such as:
29+
'no-console': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
30+
'no-debugger': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
31+
},
32+
parserOptions: {
33+
ecmaVersion: 'latest',
34+
},
35+
}

.gitignore

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
yarn-debug.log*
6+
yarn-error.log*
7+
pnpm-debug.log*
8+
lerna-debug.log*
9+
10+
node_modules
11+
.DS_Store
12+
.unlighthouse
13+
dist
14+
dist-ssr
15+
coverage
16+
*.local
17+
18+
/cypress/videos/
19+
/cypress/screenshots/
20+
21+
# Editor directories and files
22+
.vscode/*
23+
!.vscode/extensions.json
24+
!.vscode/settings.json
25+
.idea
26+
*.suo
27+
*.ntvs*
28+
*.njsproj
29+
*.sln
30+
*.sw?
31+
32+
# Pinegrow
33+
_pgbackup
34+
_pginfo
35+
36+
## optional
37+
pinegrow.json
38+
39+
## optional
40+
## Uncomment the below as per your needs
41+
## add any d.ts files that are auto-generated, for eg,
42+
auto-imports.d.ts
43+
components.d.ts
44+
composables.d.ts
45+
## rollup visualizer
46+
stats.html

.npmrc

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
shamefully-hoist=true
2+
auto-install-peers=true
3+
legacy-peer-deps=true

.prettierrc.cjs

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
module.exports = {
2+
vueIndentScriptAndStyle: true,
3+
semi: false,
4+
singleQuote: true,
5+
bracketSpacing: true,
6+
tabWidth: 2,
7+
useTabs: false,
8+
trailingComma: 'all',
9+
}

.vscode/extensions.json

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"recommendations": [
3+
"Vue.volar",
4+
"dbaeumer.vscode-eslint",
5+
"esbenp.prettier-vscode",
6+
"bradlc.vscode-tailwindcss"
7+
]
8+
}

.vscode/settings.json

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"editor.formatOnSave": true,
3+
"editor.codeActionsOnSave": {
4+
"source.fixAll": "never",
5+
"source.fixAll.eslint": "explicit"
6+
},
7+
"eslint.validate": ["javascript", "javascriptreact", "vue"],
8+
"typescript.tsdk": "node_modules/typescript/lib",
9+
"search.exclude": {
10+
"**/_pgbackup": true,
11+
"dist": true,
12+
".unlighthouse": true
13+
}
14+
}

README.md

+155
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,155 @@
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+
[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](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)

env.d.ts

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/// <reference types="vite/client" />

index.html

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8" />
5+
<link rel="icon" href="/favicon.ico" />
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7+
<title>Vue Designer</title>
8+
</head>
9+
<body>
10+
<div id="app"></div>
11+
<script type="module" src="/src/main.ts"></script>
12+
</body>
13+
</html>

netlify.toml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[build]
2+
command = "npm run build"
3+
publish = "dist"
4+
5+
[build.environment]
6+
NODE_VERSION = "20.14.0"

0 commit comments

Comments
 (0)