Skip to content
/ vue-dash Public template

A comprehensive, minimalist, high performance, beautiful and all in one admin dashboard template that build with Vue, Nuxt and Tailwind 🌟πŸ”₯✨

License

Notifications You must be signed in to change notification settings

Kei-K23/vue-dash

Repository files navigation

VueDash (Vue Nuxt.js 3 Tailwind CSS Admin Dashboard Template)

A modern, responsive, and customizable admin dashboard template built with Vue.js, Nuxt.js 3, NuxtUI and Tailwind CSS. This template is perfect for building powerful admin interfaces, dashboards, and web applications with a clean and minimal design.

πŸš€ Features

  • Nuxt.js 3: Seamless server-side rendering (SSR) and static site generation (SSG) with Vue 3 composition API.
  • Tailwind CSS: Utility-first CSS framework for fast and responsive UI development.
  • Todo Lists Management: Built-in support for CRUD todo list management
  • Invoice Maker: Built-in support for CRUD, interactive Invoice maker
  • Reusable Components: Modular and reusable UI components for easy customization.
  • Dark Mode: Built-in support for light and dark themes.
  • Responsive Design: Fully optimized for all screen sizes.
  • Dynamic Routing: Flexible routing system powered by Nuxt.js.
  • Extendable: Easy to add new pages, components, and plugins.

πŸ“¦ Tech Stack

  • Frontend Framework: Vue.js 3 (Composition API)
  • Meta Framework: Nuxt.js 3
  • Styling: Tailwind CSS
  • UI Component Library: NextUI
  • Package Manager: pnpm

πŸ› οΈ Installation

  1. Clone the repository:

    git clone https://github.com/Kei-K23/vue-dash
    cd vue-dash
  2. Install dependencies:

    pnpm install
    # or
    npm install
  3. Run the development server:

    pnpm run dev
    # or
    npm run dev
  4. Open your browser and navigate to http://localhost:3000.


πŸ—‚οΈ File Structure

admin-dashboard-template/
β”œβ”€β”€ layouts/           # Layouts for the app
β”œβ”€β”€ pages/             # Nuxt.js pages and routes
β”œβ”€β”€ features/          # Organize logic, ui components and state into domain or feature
β”œβ”€β”€ public/            # Static assets
β”œβ”€β”€ nuxt.config.ts     # Nuxt.js configuration
└── tailwind.config.js # Tailwind CSS configuration

πŸ“„ Routes and Pages Documentation

Route Page Name Description
/ Main Page The primary landing page of the admin dashboard.
/login Login Page Allows users to log in to access the admin dashboard.
/register Register Page Enables new users to create an account.
/contact Contact Page Displays a form for users to reach out for support or inquiries.
/invoice Invoice Page Displays a list of invoices or details for financial records.
/todo Todo App Page A page for managing and tracking tasks in a todo list format.
/products Products Page A page for managing product information, including details and pricing.
/order-lists Order Lists Page Lists all customer orders with options to view and manage them.
/product-stock Product Stock Page Displays current stock levels and inventory management options.
/settings Settings Page Allows users to manage system settings and personal preferences.
/team Team Page Showcases team members, roles, and permissions management options.

🎨 Customization

Tailwind CSS

Modify the tailwind.config.js file to customize themes, extend styles, or add plugins.

Components

All components are in the components/ directory inside features/(domain)/ directory. Create new components or extend existing ones to suit your project needs.

Pages and Routing

Add or edit files in the pages/ directory to create new routes dynamically.

🧩 Dependencies

πŸ“– Documentation

Setting up Authentication

You can integrate any authentication service (e.g., Firebase, Auth0, or custom JWT) using Nuxt's middleware and plugins. Refer to the Nuxt.js auth module for more details.

Adding API Integrations

Use Nuxt's server routes or external API calls in the pages/ or composables/ directories. Learn more about Nuxt.js API handling here.

πŸ§ͺ Testing

Unit Testing

Install and configure Vitest for unit testing your Vue components.

End-to-End Testing

Use Cypress or Playwright for end-to-end testing.

πŸ“‚ Deployment

  1. Static Site Generation (SSG):

    pnpm run generate

    Deploy the generated files from the dist/ folder to a static hosting provider (e.g., Netlify, Vercel).

  2. Server-Side Rendering (SSR):

    pnpm run build
    pnpm run start

    Deploy the application to Node.js hosting (e.g., AWS, Heroku, or DigitalOcean).

πŸ“§ Support

If you encounter any issues, have questions, or want to request new features or pages, feel free to open an issue or reach out to keiksl2301@gmail.com.

🀝 Contributions

Contributions are welcome! Please follow these steps:

  1. Fork the repository.
  2. Create a feature branch (git checkout -b feature-name).
  3. Commit your changes (git commit -m "Add feature").
  4. Push to the branch (git push origin feature-name).
  5. Open a pull request.

πŸ“œ License

This project is licensed under the MIT License.

🌟 Acknowledgements

Page Preview

Desktop View

desktop

Tablet View

tablet

Mobile View

mobile

About

A comprehensive, minimalist, high performance, beautiful and all in one admin dashboard template that build with Vue, Nuxt and Tailwind 🌟πŸ”₯✨

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published