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

https://github.com/Trapar-waves/vue-tailwind

A Vue 3 project template integrated with Tailwind CSS for rapid frontend development
https://github.com/Trapar-waves/vue-tailwind

Last synced: 3 months ago
JSON representation

A Vue 3 project template integrated with Tailwind CSS for rapid frontend development

Awesome Lists containing this project

README

          

# @trapar-waves/vue-tailwind

![npm version](https://img.shields.io/npm/v/@trapar-waves/vue-tailwind)
![npm dm](https://img.shields.io/npm/dm/@trapar-waves/vue-tailwind)
![License](https://img.shields.io/github/license/Trapar-waves/vue-tailwind)
![GitHub last commit](https://img.shields.io/github/last-commit/Trapar-waves/vue-tailwind)
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/Trapar-waves/vue-tailwind/release.yml)
![Renovate](https://img.shields.io/badge/renovate-enabled-blue)

---

[中文](/readme/README-CN.md) | [日本語](/readme/README-JP.md) | [Русский язык](/readme/README-RU.md)

> A Vue 3 project with Tailwind CSS and modern development tools.

## ✨ Features

- **Modern UI Framework:** Built using Vue 3 for a component-driven interface.
- **Utility-First Styling:** Employs Tailwind CSS for flexible and rapid styling.
- **Type Safety:** Leverages TypeScript to improve code quality and reduce runtime errors.
- **Fast Development Workflow:** Utilizes Rsbuild for optimized builds and quick server starts.
- **Reactive State Management:** Includes `@vueuse/core` for utilities that enhance reactivity and composition in Vue applications.
- **Customizable Icons:** Integrates Iconify for scalable and customizable icon support.
- **Code Quality Focus:** Includes ESLint and Antfu's ESLint configuration, ensuring consistent code style and reliability.
- **PostCSS Integration:** Uses `@tailwindcss/postcss` for seamless integration of Tailwind CSS with PostCSS.

## 💻 Tech Stack

- **Framework/Library:** Vue 3
- **UI Toolkit/Styling:** Tailwind CSS
- **State Management:** Reactive utilities via `@vueuse/core`
- **Build Tool:** Rsbuild
- **Language:** TypeScript
- **Linting:** ESLint with Antfu's configuration
- **Icons:** Iconify for scalable and customizable icons

See the [package.json](package.json) for a full list of dependencies.

## 🚀 Getting Started

Follow these instructions to get the project running locally.

### Prerequisites

Ensure you have the following installed:

- Node.js (>= 18.x recommended)
- Package manager (npm, yarn, or pnpm)

```bash
node -v
npm -v
```

### Installation

Run script

```bash
pnpm create trapar-waves
```

Install dependencies

```bash
npm install
yarn install
pnpm install
```

## 🤝 Contributing

Contributions are welcome and greatly appreciated! Please follow these steps to contribute:

1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request

## 👤 Author

- **Rikka:** (admin@rikka.cc)
- **GitHub Profile:** [Muromi-Rikka](https://github.com/Muromi-Rikka)

## 🔗 Links

- **Repository:** [https://github.com/Trapar-waves/vue-tailwind](https://github.com/Trapar-waves/vue-tailwind)
- **Homepage:** [https://github.com/Trapar-waves/vue-tailwind](https://github.com/Trapar-waves/vue-tailwind)
- **Issues:** [https://github.com/Trapar-waves/vue-tailwind/issues](https://github.com/Trapar-waves/vue-tailwind/issues)