Code Monkey home page Code Monkey logo

pg-iles-shadcn-vue's Introduction

Vue Designer îles Shadcn-Vue - Quick start template

This is a starter template that pre-includes the Pinegrow îles Module, Pinegrow Tailwind CSS Plugin and other goodies for Vue Designer.

Demo - https://pg-iles-shadcn-vue.netlify.app/

Vue Designer

A desktop visual editor for Vue apps supporting Mac, Windows, and Linux by Pinegrow. Take it for a free trial at Vue Designer!

It lets you visually design 🎨 your Vue single file components and boosts your productivity and creativity while building your component-based Vue apps.

It smartly integrates with your ⚡️ Vite based CLI and provides an amazing developer experience with its powerful visual controls and features.

Clean code 😃, No lock-in - You are in control of your projects and development workflow ❤️

Try it now!

1. Clone to local

Create a repo from this template on GitHub.

(or)

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

npx giget@latest gh:pinegrow/pg-iles-shadcn-vue my-iles-shadcn-vue-app #project-name
cd my-iles-shadcn-vue-app
npm install #or use pnpm

(or)

If you prefer a blank template (a single empty home page) instead,

npx giget@latest gh:pinegrow/pg-iles-shadcn-vue#blank my-iles-shadcn-vue-app #project-name
cd my-iles-shadcn-vue-app
npm install #or use pnpm

2. Open in Vue Designer

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.

Usage

Start your development server

npm run dev # SPA during development

Build

npm run build # MPA SSG (islands architecture)

Analyze

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.

npm run build # open stats.html to analyze bundle sizes

Preview

npm run now # build & preview

Lighthouse

npm run unlighthouse # Uses npx unlighthouse from https://unlighthouse.dev/ to run lighthouse on entire site (all pages)

Deploy to Netlify

You can deploy this repo as a site on your own to explore and experiment with, by clicking this button. Deploy to Netlify

Check out the deployment documentation for more information.

Pre-packed

Meta Framework (Vue-based)

  • îles - A Joyful Site Generator.
    • 🏝 [Partial Hydration] - zero JS by default, hydrates the interactive bits
    • 🔌 [Batteries Included] - layouts, components, site-wide data
    • 🧱 [Multi-Framework] - vue, preact, svelte, solid
    • 📖 [Markdown] - use components in markdown and viceversa
    • 🛣 [Routing] - automatically configured from files
    • 🛠 [Devtools][devtools] - debug panel and [hydration timeline]
    • ⚡️ [Fast][vite] - instant reloading powered by [Vite]

UI Frameworks

  • Tailwind CSS - The amazing utility-first CSS framework.

  • Shadcn-Vue - Beautifully designed components that you can copy and paste into your apps. Accessible. Customizable. Open Source. Under the hood:

    • 🦾 Radix-Vue - Completely unstyled, fully accessible UI primitives, designed to integrate beautifully with any CSS framework/library.

File-based CMS (markdown)

  • @islands/mdx - file-based CMS powered by Markdown & Vue components. This module is shipped inside îles. Note: This page is a markdown file 🗒.
  • @islands/prism - an îles module that injects a remark plugin to provide syntax highlighting for MDX documents.

Icons

  • UnoCSS Preset Icons - use over 100,000 open-source Iconify icons. Uses the unocss format for icon names, for example, i-mdi-home.

Modules/Plugins

  • Pinegrow îles Module - enables you to live-design your Vue single-file components visually in Vue Designer.
  • Pinegrow Tailwind CSS Plugin - via Design Panel, enables visual controls customization (automatic) and theme customization (optional).
  • @islands/pages - enables file-based routing, hooks to extend frontmatter and route data, supports a block in Vue single-file components for meta-data. This module is shipped inside îles.
  • 📲 unplugin-vue-components - On-demand components auto importing for Vue.
  • 📲 unplugin-auto-import - Auto import APIs on-demand for Vite, Webpack and Rollup.
  • VueUse - collection of essential Vue composition utilities.
  • 🍍 Pinia stores for global state management. Its light-weight, type-safe, extensible, modular with vue-devtools support.
  • VeeValidate takes care of value tracking, validation, errors, submissions and more.

Devtools

  • îles Devtools - Page information is available in the in-app debug panel (similar to Vitepress). Also access the "Islands" inspector in Vue devtools.
  • Vue Devtools - Official devtools that can be used as a standalone app alongside Vue Designer. It's conditionally configured in app.ts (only during development).
    • ACTION REQUIRED: Currently deactivated. In app.ts, uncomment the top devtools related snippet to activate.
  • Vite Devtools - 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.
    • ACTION REQUIRED: Currently deactivated. In iles.config.ts, uncomment VueDevtools.

VS Code Extensions

  • [VS Code Extensions](./.vscode/extensions.json & ./.vscode/settings.json)

Coding Style

Typescript

This project allows JS, and strict mode is turned off. Update tsconfig.ts as required.

{
  "compilerOptions": {
    // ...
    "strict": false,
    "allowJs": true
  }
}

Community

pg-iles-shadcn-vue's People

Contributors

techakayy avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.