๐Ÿ“ฆ vuetifyjs / nebula-ui-kit

โ˜… 0 stars โ‘‚ 0 forks ๐Ÿ‘ 0 watching
๐Ÿ“ฅ Clone https://github.com/vuetifyjs/nebula-ui-kit.git
HTTPS git clone https://github.com/vuetifyjs/nebula-ui-kit.git
SSH git clone git@github.com:vuetifyjs/nebula-ui-kit.git
CLI gh repo clone vuetifyjs/nebula-ui-kit
John Leider John Leider docs: add vercel analytic e7c4507 1 years ago ๐Ÿ“ History
๐Ÿ“‚ master View all commits โ†’
๐Ÿ“ public
๐Ÿ“ src
๐Ÿ“„ .browserslistrc
๐Ÿ“„ .editorconfig
๐Ÿ“„ .eslintrc.js
๐Ÿ“„ .gitignore
๐Ÿ“„ index.html
๐Ÿ“„ package.json
๐Ÿ“„ README.md
๐Ÿ“„ tsconfig.json
๐Ÿ“„ tsconfig.node.json
๐Ÿ“„ vite.config.ts
๐Ÿ“„ yarn.lock
๐Ÿ“„ README.md

Nebula UI Kit

A simple collection of components and layouts for building applications with Vuetify 3 and Vite.

Nebula UI Kit is a beautiful resource built over TypeScript, Vite, Vuetify 3 and Vuejs 3. It will help you get started and quickly developing your Vuetify 3 Vite applications in no time. Using the Vite theme is pretty simple but requires basic knowledge of Javascript, Vuejs and Vite.

Getting Started

  • Install Nodejs from the official Nodejs page
  • Install Yarn from the official Yarn installation page.
  • Unzip the nebula-ui-kit.zip file downloaded from the Vuetify store
  • Create a folder named nebula-ui-kit and unzip the nebula-ui-kit.zip file provided by the previous step
  • Open your terminal and navigate to the nebula-ui-kit directory
  • Run yarn install to install the project's dependencies
  • Run yarn dev to start a local development server
You can also run additional tasks such as

  • yarn run build to build your app for production
  • yarn run serve to serve your production app
  • yarn run lint to run linting.

Vuetify

Vuetify is an Open Source UI Library that is developed exactly according to Material Design spec. Every component is handcrafted to bring you the best possible UI tools to your next great app. The development doesn't stop at the core components outlined in Google's spec. Through the support of community members and sponsors, additional components will be designed and made available for everyone to enjoy.

The documentation for Vuetify is hosted here.

Not all components that are available in this project are part of the theme and may be a default Vuetify component

Vite

Vite is a build tool that significantly improves the front-end development experience. You can use Vite to set up a development environment for frameworks like Vue and React, and even for a vanilla JavaScript app with a dev server and hot reloading in just three commands. It also easily integrates with TypeScript.

Table of Contents

Demo

Quick Start

Getting started with the Nebula UI Kit is straightforward. Follow these steps to set up your development environment and begin creating your application with Vuetify 3 and Vite.

  • Ensure you have Node.js and Yarn installed on your system. If not, you can download them from the official Node.js website and Yarn installation page.
  • Download the nebula-ui-kit.zip file from the Vuetify store and unzip it into a directory of your choice.
  • Open a terminal or command prompt and navigate to the directory where you unzipped the Nebula UI Kit.
  • Run yarn install to install all dependencies.
  • Once the installation is complete, start the development server by running yarn dev.
  • Your default web browser should open automatically, displaying the Nebula UI Kit template. If it doesn't, open your browser and visit http://localhost:3000.
You are now ready to start developing with the Nebula UI Kit! Explore the components and layouts included to build your application.

Documentation

The documentation for the Nebula UI Kit covers a wide range of topics, from getting started guides to detailed descriptions of the components and their APIs. Whether you're a beginner or an experienced developer, the documentation offers the information you need to build your projects effectively.

  • Getting Started: Learn how to set up your Nebula UI Kit project and start developing.
  • Components: Explore the detailed documentation for each component, including API references, examples, and usage tips.
  • Layouts & Grid System: Understand how to utilize Vuetify's powerful layout system to create responsive and flexible UI designs.
  • Styles & Themes: Customize the look and feel of your application by leveraging Vuetify's theming system.
You can access the full documentation at Vuetify Documentation. This site also includes resources for general Vuetify usage that are applicable to the Nebula UI Kit.

File Structure

Within the download you'll find the following directories and files:

nebula-ui-kit/
โ”œโ”€โ”€ .browserslistrc
โ”œโ”€โ”€ .editorconfig
โ”œโ”€โ”€ .eslintrc.js
โ”œโ”€โ”€ .gitignore
โ”œโ”€โ”€ README.md
โ”œโ”€โ”€ index.html
โ”œโ”€โ”€ package.json
โ”œโ”€โ”€ public
โ”‚   โ”œโ”€โ”€ favicon.ico
โ”‚   โ””โ”€โ”€ nebula.png
โ”œโ”€โ”€ src
โ”‚   โ”œโ”€โ”€ App.vue
โ”‚   โ”œโ”€โ”€ assets
โ”‚   โ”‚   โ”œโ”€โ”€ content
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ content4.jpg
โ”‚   โ”‚   โ”œโ”€โ”€ heroheaders
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ heroheaders1.png
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ heroheaders2.png
โ”‚   โ”‚   โ”œโ”€โ”€ logo.png
โ”‚   โ”‚   โ”œโ”€โ”€ logo.svg
โ”‚   โ”‚   โ”œโ”€โ”€ nebula.png
โ”‚   โ”‚   โ””โ”€โ”€ pricing
โ”‚   โ”‚       โ”œโ”€โ”€ pricing-icon1.png
โ”‚   โ”‚       โ””โ”€โ”€ pricing-icon2.png
โ”‚   โ”œโ”€โ”€ components
โ”‚   โ”‚   โ”œโ”€โ”€ Logo.vue
โ”‚   โ”‚   โ”œโ”€โ”€ blog
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ Blog-v1.vue
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ Blog-v2.vue
โ”‚   โ”‚   โ”œโ”€โ”€ call-to-action
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ CalltoAction-v1.vue
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ CalltoAction-v2.vue
โ”‚   โ”‚   โ”œโ”€โ”€ contact
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ Contact-v1.vue
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ Contact-v2.vue
โ”‚   โ”‚   โ”œโ”€โ”€ content
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ Content-v1.vue
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ Content-v2.vue
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ Content-v3.vue
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ Content-v4.vue
โ”‚   โ”‚   โ”œโ”€โ”€ ecommerce
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ Ecommerce-v1.vue
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ Ecommerce-v2.vue
โ”‚   โ”‚   โ”œโ”€โ”€ features
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ Features-v1.vue
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ Features-v2.vue
โ”‚   โ”‚   โ”œโ”€โ”€ footer
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ Footer-v1.vue
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ Footer-v2.vue
โ”‚   โ”‚   โ”œโ”€โ”€ gallery
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ Gallery-v1.vue
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ Gallery-v2.vue
โ”‚   โ”‚   โ”œโ”€โ”€ header
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ Header-v1.vue
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ Header-v10.vue
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ Header-v2.vue
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ Header-v3.vue
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ Header-v4.vue
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ Header-v5.vue
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ Header-v6.vue
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ Header-v7.vue
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ Header-v8.vue
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ Header-v9.vue
โ”‚   โ”‚   โ”œโ”€โ”€ hero-headers
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ HeroHeaders-v1.vue
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ HeroHeaders-v2.vue
โ”‚   โ”‚   โ”œโ”€โ”€ pricing
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ PricingTable-v1.vue
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ PricingTable-v2.vue
โ”‚   โ”‚   โ”œโ”€โ”€ team
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ Team-v1.vue
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ Team-v2.vue
โ”‚   โ”‚   โ”œโ”€โ”€ testimonial
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ Testimonial-v1.vue
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ Testimonial-v2.vue
โ”‚   โ”‚   โ””โ”€โ”€ title
โ”‚   โ”‚       โ”œโ”€โ”€ Title-v1.vue
โ”‚   โ”‚       โ”œโ”€โ”€ Title-v2.vue
โ”‚   โ”‚       โ”œโ”€โ”€ Title-v3.vue
โ”‚   โ”‚       โ”œโ”€โ”€ Title-v4.vue
โ”‚   โ”‚       โ”œโ”€โ”€ Title-v5.vue
โ”‚   โ”‚       โ””โ”€โ”€ Title-v6.vue
โ”‚   โ”œโ”€โ”€ layouts
โ”‚   โ”‚   โ””โ”€โ”€ default
โ”‚   โ”‚       โ”œโ”€โ”€ Default.vue
โ”‚   โ”‚       โ”œโ”€โ”€ Drawer.vue
โ”‚   โ”‚       โ””โ”€โ”€ View.vue
โ”‚   โ”œโ”€โ”€ main.ts
โ”‚   โ”œโ”€โ”€ plugins
โ”‚   โ”‚   โ”œโ”€โ”€ defaults.ts
โ”‚   โ”‚   โ”œโ”€โ”€ global-components.ts
โ”‚   โ”‚   โ”œโ”€โ”€ index.ts
โ”‚   โ”‚   โ””โ”€โ”€ vuetify.ts
โ”‚   โ”œโ”€โ”€ router
โ”‚   โ”‚   โ””โ”€โ”€ index.ts
โ”‚   โ”œโ”€โ”€ styles
โ”‚   โ”‚   โ”œโ”€โ”€ overrides.scss
โ”‚   โ”‚   โ””โ”€โ”€ settings.scss
โ”‚   โ”œโ”€โ”€ views
โ”‚   โ”‚   โ”œโ”€โ”€ blog
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ index.vue
โ”‚   โ”‚   โ”œโ”€โ”€ call-to-action
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ index.vue
โ”‚   โ”‚   โ”œโ”€โ”€ contact
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ index.vue
โ”‚   โ”‚   โ”œโ”€โ”€ content
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ index.vue
โ”‚   โ”‚   โ”œโ”€โ”€ ecommerce
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ index.vue
โ”‚   โ”‚   โ”œโ”€โ”€ features
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ index.vue
โ”‚   โ”‚   โ”œโ”€โ”€ footer
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ index.vue
โ”‚   โ”‚   โ”œโ”€โ”€ gallery
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ index.vue
โ”‚   โ”‚   โ”œโ”€โ”€ headers
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ index.vue
โ”‚   โ”‚   โ”œโ”€โ”€ hero-headers
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ index.vue
โ”‚   โ”‚   โ”œโ”€โ”€ pricing
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ index.vue
โ”‚   โ”‚   โ”œโ”€โ”€ team
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ index.vue
โ”‚   โ”‚   โ”œโ”€โ”€ testimonial
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ index.vue
โ”‚   โ”‚   โ””โ”€โ”€ title
โ”‚   โ”‚       โ””โ”€โ”€ index.vue
โ”‚   โ””โ”€โ”€ vite-env.d.ts
โ”œโ”€โ”€ tsconfig.json
โ”œโ”€โ”€ tsconfig.node.json
โ”œโ”€โ”€ vite.config.ts
โ””โ”€โ”€ yarn.lock

Browser Support

BrowserStatus
Chromium (Chrome, Edge)โœ… Supported
Firefoxโœ… Supported
Safari 15.4+โœ… Supported
Safari 13.โ— Requires polyfill
Edge <79โ›” Not supported
Internet Explorerโ›” Not supported

Resources

Reporting Issues

Please report issues to the Vuetify Discord

Technical Support or Questions

If you encounter any issues or have questions about using the Nebula UI Kit, there are several ways to get help:

We strive to provide comprehensive support to ensure your success with the Nebula UI Kit. Don't hesitate to reach out with your questions or feedback.

Licensing

Useful Links