Skip to content
/ Vuyah Public

A modern, scalable, and developer-friendly boilerplate for Vue.js 3 projects, featuring TypeScript, Pinia, Vite, and a modular FSD-based architecture for rapid and maintainable development. πŸš€

Notifications You must be signed in to change notification settings

oobg/Vuyah

Repository files navigation

Vuyah πŸš€

Vuyah is a modern and powerful boilerplate for Vue.js projects. Built on a flexible and scalable structure, it accelerates development and simplifies maintenance. Start building creative and efficient applications with Vuyah today!

Refer to the translated README at the links below

For detailed information about the current project, please refer to the blog post below.

✨ Features

1. Latest Technology Stack

  • Vue 3: Modern and robust Vue.js framework.
  • TypeScript Ready: Enhanced readability and stability with powerful typing.
  • Pinia: The next-generation state management library for Vue.js.
  • Vite: Ultra-fast build and development server tooling.

2. Structured Project Design

  • Based on FSD (Feature-Sliced Design) for maintainability and scalability.
  • Modular design for widgets, layouts, and state management.

3. Efficient Development Environment

  • ESLint & Prettier: Consistent code style and quality enforcement.

πŸ“‚ Project Structure

src/
β”œβ”€β”€ app/               # Global application settings
β”‚   β”œβ”€β”€ plugins/       # Plugin configurations (e.g., Pinia, Router)
β”‚   β”œβ”€β”€ styles/        # Global styles
β”‚   └── main.ts        # Entry point
β”œβ”€β”€ shared/            # Reusable utilities and components
β”œβ”€β”€ widget/            # Layouts and widgets
β”œβ”€β”€ features/          # Domain-specific features
└── pages/             # Page-level views

πŸš€ Getting Started

1. Clone the repository

git clone https://github.com/oobg/vuyah.git

2. Install dependencies

npm install

3. Run the development server

npm run dev

4. Build for production

npm run build

πŸ› οΈ Available Scripts

  • npm run dev: Start the development server.
  • npm run build: Build for production.
  • npm run lint: Run linting.
  • npm run test: Run tests.

🌟 Why Choose Vuyah?

1. Boost Productivity

Vuyah speeds up development and simplifies project maintenance.

2. Scalability & Flexibility

Its well-structured architecture ensures ease of feature expansion.

3. Optimized Developer Experience

Leverage the latest Vue.js technology stack for a seamless experience.

About

A modern, scalable, and developer-friendly boilerplate for Vue.js 3 projects, featuring TypeScript, Pinia, Vite, and a modular FSD-based architecture for rapid and maintainable development. πŸš€

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published