Skip to content

Commit

Permalink
chore: updated README.md file.
Browse files Browse the repository at this point in the history
  • Loading branch information
@DeepKumbhare85
DeepKumbhare85 committed Jun 1, 2023
1 parent 22609d4 commit c714674
Showing 1 changed file with 148 additions and 21 deletions.
169 changes: 148 additions & 21 deletions typescript-version/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,35 +1,162 @@
# vue
<p align="center"></p>

This template should help get you started developing with Vue 3 in Vite.
<p align="center">
<a href="https://themeselection.com/item/materio-free-vuetify-vuejs-admin-template/" target="_blank">
<img src="https://cdn.jsdelivr.net/gh/themeselection/ts-assets/materio/materio-vuetify-vuejs-admin-template-free/logo/logo.png" alt="materio-logo" width="60px" height="auto">
</a>
</p>

## Recommended IDE Setup
<h1 align="center">
<a href="https://themeselection.com/item/materio-free-vuetify-vuejs-admin-template/" target="_blank" align="center">
Materio – Vuetify Vuejs Admin Template Free
</a>
</h1>

[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar) (and disable Vetur).
<p align="center">Production Ready, Carefully Crafted, Extensive Vuetifty Admin Template</p>

## Type Support for `.vue` Imports in TS
<p align="center">
<a href="{licence_url_of_current_repo}">
<img src="https://img.shields.io/github/license/themeselection/{repo_name_from_url}" alt="license">
</a>
<img alt="GitHub Workflow Status" src="https://img.shields.io/github/workflow/status/themeselection/{repo_name_from_url}/Deploy">
<a href="{repo_url}/releases">
<img src="https://img.shields.io/github/release/themeselection/{repo_name_from_url}.svg" alt="GitHub release">
</a>
<a href="https://twitter.com/Theme_Selection" target="_blank">
<img alt="Twitter Follow" src="https://img.shields.io/twitter/follow/Theme_Selection">
</a>
</p>

Since TypeScript cannot handle type information for `.vue` imports, they are shimmed to be a generic Vue component type by default. In most cases this is fine if you don't really care about component prop types outside of templates.
<kbd>[![Materio – Vuetify Vuejs Admin Template Demo Screenshot](https://cdn.jsdelivr.net/gh/themeselection/ts-assets/materio/materio-vuetify-vuejs-admin-template-free/banner/materio-vue-free.png)](https://themeselection.com/item/materio-free-vuetify-vuejs-admin-template/))</kbd>

However, if you wish to get actual prop types in `.vue` imports (for example to get props validation when using manual `h(...)` calls), you can run `Volar: Switch TS Plugin on/off` from VSCode command palette.
## Introduction 🚀

## Customize configuration
If you're a developer looking for an admin dashboard that is developer-friendly, rich with features, and highly customizable look no further than Materio. We've followed the highest industry standards to bring you one of the very best [VueJS Admin Templates](https://themeselection.com/products/category/vuejs-admin-templates/) that is not only fast and easy to use but highly scalable. Offering ultimate convenience and flexibility, you'll be able to build whatever application you want with very little hassle.

See [Vite Configuration Reference](https://vitejs.dev/config/).
- ⚡️ [Vue 3](https://github.com/vuejs/core), [Vite 3](https://github.com/vitejs/vite) & [Vuetify 3](https://next.vuetifyjs.com/en/) - Uses the latest Vuetify 3
- 🗂 [File based routing](https://github.com/hannoeru/vite-plugin-pages)
- 📦 [Components auto importing](https://github.com/antfu/unplugin-vue-components)
- 📑 [Layout system](https://github.com/JohnCampionJr/vite-plugin-vue-layouts)
- 😃 Use icons from any icon sets with classes by [Iconify](https://iconify.design/)
- 🌍 I18n ready
- 🔥 Use the [`<script setup>`](https://vuejs.org/api/sfc-script-setup.html) syntax
- 📥 [APIs auto importing](https://github.com/antfu/unplugin-auto-import) - use Composition API and others directly
- 🦾 TypeScript & JavaScript versions

## Project Setup
[View Demo](https://demos.themeselection.com/materio-vuetify-vuejs-admin-template-free/demo/dashboard)

```sh
npm install
```
## Installation ⚒️

### Compile and Hot-Reload for Development
Please [visit](https://demos.themeselection.com/materio-vuetify-vuejs-admin-template/documentation/guide/installation.html) our docs for installation guide.

```sh
npm run dev
```
## What's Included 📦

### Type-Check, Compile and Minify for Production
- Dashboard
- Account Settings
- Pages
- Login
- Register
- Error
- Typography
- Material Design Icons
- Cards
- Form layouts
- Horizontal Form
- Horizontal Form with Icons
- Vertical Form
- Vertical Form with Icons
- Multiple Column
- Tables

```sh
npm run build
```

## What's in Premium Version 💎

| Materio Free Version | Materio Premium Version |
| ------------------------------------------------------------------------------------------------ | :--------------------------------------------------------------------------------------------- |
| [Demo](https://demos.themeselection.com/materio-vuetify-vuejs-admin-template-free/demo/dashboard) | [Demo](https://themeselection.com/demo/materio-vuetify-vuejs-admin-template/landing) |
| [Download](https://themeselection.com/item/materio-free-vuetify-vuejs-admin-template/) | [Purchase](https://themeselection.com/item/materio-vuetify-vuejs-admin-template/) |
| Single vertical menu | Vertical (+ vertical collapsed) & Horizontal menu |
| Simple Light/Dark theme | 3 Skin variants w/ light/dark theme support: Default, Bordered & Semi-dark |
| 1 Simple Dashboard | 3 Niche Dashboards |
| - | 5 API ready applications |
| Simple From Elements | Advance form elemens, validation & form wizard |
| Basic Cards | Basic Cards + Advanced Cards + Statistics Cards |
| - | API ready JWT Authentication flow |
| - | Access Control (even on CRUD operations) |
| - | Quick Search - Quickly navigate between pages (w/ hotkey support) |
| Basic Pages | Authentication Pages in 2 variants + Ready to use pages like Pricing, FAQ, Knowledge base, etc |
| - | 3D Characters + Illustrations |
| Basic tables | Advanced tables |
| Manual customization | Quick customization using theme config file |
| - | Advanced Charts |
| 1 Chart Library | 2 Chart Libraries |
| - | Multiple Navbar & Menu Options |
| - | Starter-kit |
| - | Internationalization support in components |
| Regular Support | Priority Support |
| Basic Documentation

## Documentation 📜

Check out our live [Documentation](https://demos.themeselection.com/materio-vuetify-vuejs-admin-template/documentation/)

## Browser Support 🖥️

At present, we officially aim to support the last two versions of the following browsers:

- Chrome (latest)
- FireFox (latest)
- Safari (latest)
- Microsoft Edge (latest)
- Opera (latest)

## Contributing 🦸

Contribution are always welcome and recommended! Here is how:

* Fork the repository ([here is the guide](https://docs.github.com/en/get-started/quickstart/fork-a-repo)).
* Clone to your machine `git clone https://github.com/YOUR_USERNAME/REPO_NAME` Make your changes
* Create a pull request

### Contribution Requirements 🧰

* When you contribute, you agree to give a non-exclusive license to ThemeSelection to use that contribution in any context as we (ThemeSelection) see appropriate.
* If you use content provided by another party, it must be appropriately licensed using an open source license.
* Contributions are only accepted through Github pull requests.
* Finally, contributed code must work in all supported browsers (see above for browser support).

## Creators 😇

* [ThemeSelection](https://themeselection.com)

## Changelog 📆

Please refer to the [CHANGELOG](CHANGELOG.md) file. We will add a detailed release notes to each new release.

## NOTE 🏷️

**We request you to keep ThemeSelection credit link in the footer section.**

## Looking For Premium Admin Templates ?? 👀

**[ThemeSelection](https://themeselection.com/)** provides Selected high quality, modern design, professional and easy-to-use Free and Premium [Bootstrap Admin Templates](https://themeselection.com/products/category/bootstrap-admin-templates/), [VueJS Admin Templates](https://themeselection.com/products/category/vuejs-admin-templates/), [Laravel Admin Templates](https://themeselection.com/products/category/laravel-admin-templates/), HTML Themes, and [Free UI Kits](https://themeselection.com/products/category/free-ui-kits/) to create your applications faster!.

If you want to [Download Free Admin Templates](https://themeselection.com/products/category/download-free-admin-templates/) like Materio then do visit [ThemeSelection](https://themeselection.com/).

## Other variants

* [Vue Laravel variant](https://themeselection.com/item/materio-free-vuetify-vuejs-laravel-admin-template/)
<!-- Add others here -->

## Useful Links 🎁

* [Freebies](https://themeselection.com/products/category/download-free-admin-templates/)
* [Download Free Admin Templates](https://themeselection.com/products/category/download-free-admin-templates/)
* [Bootstrap 5 CheatSheet](https://bootstrap-cheatsheet.themeselection.com/)

## Social Media :earth_africa:

- Twitter : [https://twitter.com/Theme_Selection](https://twitter.com/Theme_Selection)
- Facebook : [https://www.facebook.com/ThemeSelections/](https://www.facebook.com/ThemeSelections/)
- Pinterest : [https://pinterest.com/themeselect/](https://pinterest.com/themeselect/)
- Instagram : [https://www.instagram.com/themeselection/](https://www.instagram.com/themeselection/)

0 comments on commit c714674

Please sign in to comment.