Skip to content

Commit bf279b4

Browse files
committed
Update the readme
1 parent 1dd59ec commit bf279b4

File tree

1 file changed

+199
-17
lines changed

1 file changed

+199
-17
lines changed

README.md

Lines changed: 199 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,206 @@
1-
# vue-soft-ui-dashboard-pro
1+
# [Vue Soft UI Dashboard](http://demos.creative-tim.com/vue-soft-ui-dashboard/?ref=readme-vsud) [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&logo=twitter)](https://twitter.com/intent/tweet?url=https://www.creative-tim.com/product/vue-soft-ui-dashboard&text=Check%20Vue%20Soft%20UI%20Dashboard%20made%20by%20@CreativeTim%20#webdesign%20#dashboard%20#softdesign%20#vue%20https://www.creative-tim.com/product/vue-soft-ui-dashboard)
22

3-
## Project setup
4-
```
5-
npm install
6-
```
3+
![version](https://img.shields.io/badge/version-1.0.0-blue.svg) [![GitHub issues open](https://img.shields.io/github/issues/creativetimofficial/vue-soft-ui-dashboard.svg)](https://github.com/creativetimofficial/vue-soft-ui-dashboard/issues?q=is%3Aopen+is%3Aissue) [![GitHub issues closed](https://img.shields.io/github/issues-closed-raw/creativetimofficial/vue-soft-ui-dashboard.svg)](https://github.com/creativetimofficial/vue-soft-ui-dashboard/issues?q=is%3Aissue+is%3Aclosed)
74

8-
### Compiles and hot-reloads for development
9-
```
10-
npm run serve
11-
```
5+
![Image](https://s3.amazonaws.com/creativetim_bucket/products/591/original/vue-soft-ui-dashboard.jpg)
126

13-
### Compiles and minifies for production
14-
```
15-
npm run build
16-
```
7+
Start your Development with an Innovative Admin Template for Bootstrap 5 and VueJS 3. If you like the look & feel of the hottest design trend right now, Soft UI, you will fall in love with this dashboard! It features a huge number of components built to fit together and look amazing.
8+
9+
**Fully Coded Components**
10+
11+
Vue Soft UI Dashboard is built with over 70 frontend individual elements, like buttons, inputs, navbars, nav tabs, cards, or alerts, giving you the freedom of choosing and combining. All components can take variations in color, which you can easily modify using SASS files and classes. You will save a lot of time going from prototyping to full-functional code because all elements are implemented.
12+
13+
This Free Bootstrap 5 & VueJS 3 Dashboard is coming with prebuilt design blocks, so the development process is seamless,
14+
switching from our pages to the real website is very easy to be done.
15+
16+
View [all components here](https://www.creative-tim.com/learning-lab/vue/alerts/soft-ui-dashboard/).
17+
18+
**Documentation built by Developers**
19+
20+
Each element is well presented in very complex documentation.
21+
You can read more about the [documentation here](https://www.creative-tim.com/learning-lab/vue/overview/soft-ui-dashboard/).
22+
23+
**Example Pages**
24+
25+
If you want to get inspiration or just show something directly to your clients, you can jump-start your development with our pre-built example pages. Every page is spaced well, with attractive layouts and pleasing shapes. From specially designed dashboards for smart homes, virtual reality, and automotives to CRM admins, Vue Soft UI Dashboard has everything you need to quickly set up an amazing project.
26+
27+
View [example pages here](https://demos.creative-tim.com/vue-soft-ui-dashboard/).
28+
29+
**HELPFUL LINKS**
30+
31+
- View [Github Repository](https://github.com/creativetimofficial/vue-soft-ui-dashboard)
32+
- Check [FAQ Page](https://www.creative-tim.com/faq)
33+
34+
#### Special thanks
35+
36+
During the development of this dashboard, we have used many existing resources from awesome developers. We want to thank them for providing their tools open source:
37+
38+
- [Popper.js](https://popper.js.org/) - Kickass library used to manage poppers
39+
40+
Let us know your thoughts below. And good luck with development!
41+
42+
## Table of Contents
43+
44+
- [Versions](#versions)
45+
- [Demo](#demo)
46+
- [Quick Start](#quick-start)
47+
- [Documentation](#documentation)
48+
- [File Structure](#file-structure)
49+
- [Browser Support](#browser-support)
50+
- [Resources](#resources)
51+
- [Reporting Issues](#reporting-issues)
52+
- [Technical Support or Questions](#technical-support-or-questions)
53+
- [Licensing](#licensing)
54+
- [Useful Links](#useful-links)
55+
56+
## Versions
57+
58+
[<img src="https://raw.githubusercontent.com/creativetimofficial/public-assets/master/logos/vue-logo.jpg?raw=true" width="60" height="60" />](https://www.creative-tim.com/product/vue-soft-ui-dashboard?ref=readme-vsud)
59+
60+
| VueJS |
61+
| ----- |
62+
63+
| [![Vue Soft UI Dashboard](https://s3.amazonaws.com/creativetim_bucket/products/591/thumb/vue-soft-ui-dashboard.jpg)](http://demos.creative-tim.com/vue-soft-ui-dashboard/?ref=readme-vsud)
64+
65+
## Demo
66+
67+
- [Profile](https://demos.creative-tim.com/vue-soft-ui-dashboard/#/profile?ref=readme-vsud)
68+
- [Sign In](https://demos.creative-tim.com/vue-soft-ui-dashboard/#/sign-in?ref=readme-vsud)
69+
- [Sign Up](https://demos.creative-tim.com/vue-soft-ui-dashboard/#/sign-up?ref=readme-vsud)
70+
71+
[View More](https://demos.creative-tim.com/vue-soft-ui-dashboard/#/dashboard?ref=readme-vsud).
72+
73+
## Quick start
74+
75+
Quick start options:
76+
77+
- Download from [Creative Tim](https://www.creative-tim.com/product/vue-soft-ui-dashboard?ref=readme-vsud).
78+
79+
## Terminal Commands
80+
81+
1. Download and Install NodeJs LTS version from [NodeJs Official Page](https://nodejs.org/en/download/).
82+
2. Navigate to the root ./ directory of the product and run `npm install` to install our local dependencies.
83+
84+
## Documentation
85+
86+
The documentation for the Soft UI Dashboard is hosted at our [website](https://www.creative-tim.com/learning-lab/vue/overview/soft-ui-dashboard/?ref=readme-vsud).
87+
88+
### What's included
89+
90+
Within the download you'll find the following directories and files:
1791

18-
### Lints and fixes files
1992
```
20-
npm run lint
93+
vue-soft-ui-dashboard
94+
├── public
95+
│   ├── favicon.png
96+
│   └── index.html
97+
├── src
98+
│   ├── assets
99+
│ │   ├── css
100+
│ │   ├── fonts
101+
│ │   ├── img
102+
│ │   ├── js
103+
│ │   └── scss
104+
│   ├── components
105+
│ │   ├── Icon.vue
106+
│ │   ├── VsudAlert.vue
107+
│ │   ├── VsudAvatar.vue
108+
│ │   ├── VsudBadge.vue
109+
│ │   ├── VsudButton.vue
110+
│ │   ├── VsudCheckbox.vue
111+
│ │   ├── VsudInput.vue
112+
│ │   ├── VsudPagination.vue
113+
│ │   ├── VsudPaginationItem.vue
114+
│ │   ├── VsudProgress.vue
115+
│ │   ├── VsudRadio.vue
116+
│ │   ├── VsudSwitch.vue
117+
│ │   └── VsudTextarea.vue
118+
│   ├── examples
119+
│ │   ├── Cards
120+
│ │   ├── Charts
121+
│ │   ├── Navbars
122+
│ │   ├── PageLayout
123+
│ │   ├── Sidenav
124+
│ │   ├── Breadcrumbs.vue
125+
│ │   ├── Configurator.vue
126+
│ │   └── Footer.vue
127+
│   ├── router
128+
│   ├── store
129+
│   ├── views
130+
│ │   ├── components
131+
│ │   ├── Billing.vue
132+
│ │   ├── Dashboard.vue
133+
│ │   ├── Home.vue
134+
│ │   ├── Profile.vue
135+
│ │   ├── Rtl.vue
136+
│ │   ├── SignIn.vue
137+
│ │   ├── SignUp.vue
138+
│ │   ├── Tables.vue
139+
│ │   └── VirtualReality.vue
140+
│   ├── App.vue
141+
│   ├── main.js
142+
│   └── soft-ui-dashboard.js
143+
├── .browserslistrc
144+
├── .eslintrc.js
145+
├── .gitignore
146+
├── babel.config.js
147+
├── CHANGELOG.md
148+
├── ISSUE_TEMPLATE.md
149+
├── LICENSE.md
150+
├── package.json
151+
└── README.md
21152
```
22153

23-
### Customize configuration
24-
See [Configuration Reference](https://cli.vuejs.org/config/).
154+
## Browser Support
155+
156+
At present, we officially aim to support the last two versions of the following browsers:
157+
158+
<img src="https://s3.amazonaws.com/creativetim_bucket/github/browser/chrome.png" width="64" height="64"> <img src="https://s3.amazonaws.com/creativetim_bucket/github/browser/firefox.png" width="64" height="64"> <img src="https://s3.amazonaws.com/creativetim_bucket/github/browser/edge.png" width="64" height="64"> <img src="https://s3.amazonaws.com/creativetim_bucket/github/browser/safari.png" width="64" height="64"> <img src="https://s3.amazonaws.com/creativetim_bucket/github/browser/opera.png" width="64" height="64">
159+
160+
## Resources
161+
162+
- [Live Preview](https://demos.creative-tim.com/vue-soft-ui-dashboard/#/dashboard?ref=readme-vsud)
163+
- [Download Page](https://www.creative-tim.com/product/vue-soft-ui-dashboard?ref=readme-vsud)
164+
- Documentation is [here](https://www.creative-tim.com/learning-lab/vue/overview/soft-ui-dashboard/?ref=readme-vsud)
165+
- [License Agreement](https://www.creative-tim.com/license?ref=readme-vsud)
166+
- [Support](https://www.creative-tim.com/contact-us?ref=readme-vsud)
167+
- Issues: [Github Issues Page](https://github.com/creativetimofficial/vue-soft-ui-dashboard/issues)
168+
169+
## Reporting Issues
170+
171+
We use GitHub Issues as the official bug tracker for the Soft UI Dashboard PRO React. Here are some advices for our users that want to report an issue:
172+
173+
1. Make sure that you are using the latest version of the Soft UI Dashboard PRO React. Check the CHANGELOG from your dashboard on our [website](https://www.creative-tim.com/product/vue-soft-ui-dashboard-pro?ref=readme-vsud).
174+
2. Providing us reproducible steps for the issue will shorten the time it takes for it to be fixed.
175+
3. Some issues may be browser specific, so specifying in what browser you encountered the issue might help.
176+
177+
## Technical Support or Questions
178+
179+
If you have questions or need help integrating the product please [contact us](https://www.creative-tim.com/contact-us?ref=readme-vsud) instead of opening an issue.
180+
181+
## Licensing
182+
183+
- Copyright 2021 [Creative Tim](https://www.creative-tim.com?ref=readme-vsud)
184+
- Creative Tim [license](https://www.creative-tim.com/license?ref=readme-vsud)
185+
186+
## Useful Links
187+
188+
- [More products](https://www.creative-tim.com/templates?ref=readme-vsud) from Creative Tim
189+
190+
- [Tutorials](https://www.youtube.com/channel/UCVyTG4sCw-rOvB9oHkzZD1w)
191+
192+
- [Freebies](https://www.creative-tim.com/bootstrap-themes/free?ref=readme-vsud) from Creative Tim
193+
194+
- [Affiliate Program](https://www.creative-tim.com/affiliates/new?ref=readme-vsud) (earn money)
195+
196+
##### Social Media
197+
198+
Twitter: <https://twitter.com/CreativeTim>
199+
200+
Facebook: <https://www.facebook.com/CreativeTim>
201+
202+
Dribbble: <https://dribbble.com/creativetim>
203+
204+
Google+: <https://plus.google.com/+CreativetimPage>
205+
206+
Instagram: <https://instagram.com/creativetimofficial>

0 commit comments

Comments
 (0)