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

https://github.com/vue-blocks/vue-blocks

The ultimate front-end building block library specifically designed for Vue
https://github.com/vue-blocks/vue-blocks

blocks component shadcn shadcn-vue tailwind tailwind-css tailwindcss vue vue-blocks vueblocks

Last synced: 9 months ago
JSON representation

The ultimate front-end building block library specifically designed for Vue

Awesome Lists containing this project

README

          



VueBlocks - The ultimate front-end building block library specifically designed for Vue



The ultimate front-end building block library specifically designed for Vue

## πŸš€ Project Overview

Vue Blocks is a modern Vue.js component library and development toolkit designed to accelerate UI development. It
provides a collection of pre-built, customizable components and blocks that follow best practices for performance,
accessibility, and design consistency.

### ✨Features

- πŸš€ **Rapid Development** - pre-built component blocks, ready to use out of the box
- 🎨 **Aesthetic Design** - elaborately designed modern interface
- πŸ“± **Responsive** - perfectly adapted to various device sizes
- πŸ”§ **Easy to customize** - flexible configuration and style customization
- πŸ“¦ **Modularization** - introduced on demand to reduce package size

### πŸ› οΈ Tech Stack

- **Framework**: Vue 3 + Nuxt4 + Shadcn/vue
- **Build Tool**: Vite
- **Styling**: Tailwind CSS
- **Type Safety**: TypeScript
- **Package Manager**: npm

## πŸ“¦ Getting Started

### Development Setup

Follow these steps to set up the development environment:

#### Step 1: Clone the Repository

```bash
git clone https://github.com/vue-blocks/vue-blocks
```

#### Step 2: Install Dependencies

```bash
npm install
```

#### Step 3: Start Development Server

```bash
npm run dev
```

The development server will start at `http://localhost:3000`

### πŸ—οΈ Adding New Block

To create and register new block modules:

#### Step 1: Complete Development Setup

Ensure you have completed all steps in the "Development Setup" section above.

#### Step 2: Generate Block Template

```bash
npm run registry:template
```

This command creates a new block module with the standard structure and boilerplate code.

#### Step 3: Run the build script

```shell
npm run registry:build
```

> **Note**: Note: you do not need to run this script for every change. You only need to run it when you update the block
> definition.

## 🀝 Contributing

Welcome to submit issues and Pull requests to help improve the project

## πŸ“„ License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.