๐Ÿ“ฆ vuetifyjs / theme-vite-free

๐Ÿ“„ README.md ยท 135 lines
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135# [Vite Theme Free](https://store.vuetifyjs.com/products/vite-theme-free)
A free Vuetify 3 theme using Vite.

![version](https://img.shields.io/badge/version-1.0.0-blue.svg)[![Chat](https://img.shields.io/badge/chat-on%20discord-7289da.svg)](https://discord.com/invite/s93b7Fv)

**Vite Theme Free** is a beautiful resource built over [Vite](https://vitejs.dev/guide/), [Vuetify 3](https://vuetifyjs.com/) and [Vuejs 3](https://vuejs.org/). 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](https://vuejs.org) and [Vite](https://vitejs.dev/guide/).

## Getting Started

- Install Nodejs from the official [Nodejs page](https://nodejs.org/en/)
- Install Yarn from the official [Yarn installation page](https://classic.yarnpkg.com/en/docs/install/#windows-stable).
- Unzip the `vite-theme-free.zip` file downloaded from the Vuetify store
- Create a folder named `vite-theme` and unzip the `vite-theme-free.zip` file provided by the previous step
- Open your terminal and navigate to the `vite-theme` 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](https://vuetifyjs.com/).

***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](https://vitejs.dev/guide/features.html#typescript).

## Vue-cli

We use the latest 3.x [Vue CLI](https://github.com/vuejs/vue-cli) which aims to reduce project configuration
to as little as possible. Almost everything is inside `package.json` + some other related files such as
`.babel.config.js`, `.eslintrc.js` and `.postcssrc.js`.

Let us know what you think and what we can improve below. And good luck with development!

## Table of Contents

- [Demo](#demo)
- [Quick Start](#quick-start)
- [Documentation](#documentation)
- [File Structure](#file-structure)
- [Browser Support](#browser-support)
- [Resources](#resources)
- [Reporting Issues](#reporting-issues)
- [Technical Support or Questions](#technical-support-or-questions)
- [Licensing](#licensing)
- [Useful Links](#useful-links)

## Demo

- [Demo page](https://store.vuetifyjs.com/products/vite-theme-free/preview)

## File Structure

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

<details>

```txt
vite-theme-free/
โ”ฃ public/
โ”ƒ โ”— favicon.ico
โ”ฃ src/
โ”ƒ โ”ฃ plugins/
โ”ƒ โ”ƒ โ”ƒ  index.js
โ”ƒ โ”ƒ โ”ƒ  vuetify.js
โ”ƒ โ”ƒ โ”—  webfontloader.js
โ”ƒ โ”ฃ App.vue
โ”ƒ โ”— main.js
โ”ฃ .editorconfig
โ”ฃ .gitignore
โ”ฃ index.html
โ”ฃ package.json
โ”ฃ README.md
โ”ฃ vite.config.js
โ”— yarn.lock
```

</details>

## Browser Support

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

## Resources

- [Live Preview](https://theme-vite-free.vercel.app/)
- Product Page: [Product](https://store.vuetifyjs.com/products/vite-theme-free)
- Vuetify Documentation is [Here](https://vuetifyjs.com/)
- Contact: [Contact](mailto:support@vuetifyjs.com)

## Reporting Issues

We use GitHub Issues as the official bug tracker for the **Vite Theme Free** theme. Here is some advice for our users that want to report an issue:

1. Providing us reproducible steps for the issue will shorten the time it takes for it to be fixed.
2. Some issues may be browser specific, so specifying what browser you encountered the issue will be helpful.

## Technical Support or Questions

If you have questions or need help integrating the product please reach out in [Discord](https://discord.com/invite/s93b7Fv).

## Licensing

- Copyright 2023 Vuetify <https://vuetifyjs.com/>
- Vuetify [License Information](https://github.com/vuetifyjs/vuetify/blob/master/LICENSE.md)

## Useful Links

- [Vuetify Documentation](https://vuetifyjs.com/)
- [Vuetify Store](https://store.vuetifyjs.com/)
- [Discord](https://community.vuetifyjs.com)
- [Twitter](https://twitter.com/vuetifyjs)

<br>

<p align="center">
  <img src="https://cdn.vuetifyjs.com/docs/images/logos/v.png" height="128">
</p>