/uno-vuejs-boilerplate

VueJS + UnoCSS minimal starter

Primary LanguageVueMIT LicenseMIT

UnoCSS + VueJS Starter

A minimal starter project that combines VueJS and UnoCSS. It includes essential dependencies like clsx, tailwind-merge,unhead. It leverages various tools and libraries to provide a seamless development experience.

💻 Stack/Dependencies

  • vue: A progressive framework for building user interfaces.
  • vue-router: Official router for Vue.js, used for managing application routes.
  • vue-use/core: Collection of essential Vue Composition API utilities.
  • vite: A fast build tool for Vue.js projects.
  • typescript: A typed superset of JavaScript that compiles to plain JavaScript.
  • unocss: A utility-first CSS framework for rapid UI development.
  • eslint: A pluggable and configurable linter tool for identifying and reporting on patterns in JavaScript.
  • prettier: An opinionated code formatter to enforce consistent code style.

📝 Folder Structure

  • src: Contains the main source code of the Vue project.
  • src/assets: Stores static assets such as images, fonts, and stylesheets.
  • src/components: Houses reusable Vue components used throughout the project.
  • src/components/element: Contains Vue components.
  • src/components/layouts: Stores layout components used for structuring the application's UI.
  • src/components/ui: Contains UI components that are not specific to any particular library or framework.
  • src/lib: Stores custom libraries or utilities created for the project.
  • src/router: Contains the Vue Router configuration for managing application routing.
  • src/views: Houses the main views or pages of the application.
  • public: Contains static files that are directly copied to the build folder during the build process.

Customize configuration

See Vite Configuration Reference.

Project Setup

  1. Clone the uno-vuejs-boilerplate repository:
git clone https://github.com/unify-ui-dev/uno-vuejs-boilerplate
  1. Install the dependencies:
npm install
pnpm install
yarn install

Feel free to use any other package manager like :

pnpm install
bun install
yarn install

Compile and Hot-Reload for Development

npm run dev

Type-Check, Compile and Minify for Production

npm run build

Lint with ESLint

npm run lint

📄 License

This project is licensed under the MIT License - see the MIT License file for details.