You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[]()[]()[](https://gitter.im/creative-tim/material-dashboard-react?utm_source=share-link&utm_medium=link&utm_campaign=share-link)[](https://discord.gg/E4aHAQy)
6
+
7
+

5
8
6
9
Material Dashboard React is a free Material-UI Admin with a fresh, new design inspired by Google's Material Design. We are very excited to introduce our take on the material concepts through an easy to use and beautiful set of components. Material Dashboard React was built over the popular Material-UI framework.
7
10
@@ -18,30 +21,57 @@ We are very excited to share this dashboard with you and we look forward to hear
18
21
19
22
You can find the Github Repo here.
20
23
21
-
## Links:
24
+
## Table of Contents
25
+
26
+
*[Versions](#versions)
27
+
*[Demo](#demo)
28
+
*[Quick Start](#quick-start)
29
+
*[Documentation](#documentation)
30
+
*[File Structure](#file-structure)
31
+
*[Browser Support](#browser-support)
32
+
*[Resources](#resources)
33
+
*[Reporting Issues](#reporting-issues)
34
+
*[Technical Support or Questions](#technical-support-or-questions)
-[Download from Github](https://github.com/creativetimofficial/material-dashboard-react/archive/master.zip).
31
-
-[Download from Creative Tim](http://www.creative-tim.com/product/material-dashboard-react).
64
+
-`npm i material-dashboard-react`
32
65
- Clone the repo: `git clone https://github.com/creativetimofficial/material-dashboard-react.git`.
66
+
-[Download from Github](https://github.com/creativetimofficial/material-dashboard-react/archive/master.zip).
67
+
-[Download from Creative Tim](https://www.creative-tim.com/product/material-dashboard-react).
33
68
34
-
## Terminal Commands
35
69
36
-
1. Install NodeJs from [NodeJs Official Page](https://nodejs.org/en).
37
-
2. Open Terminal
38
-
3. Go to your file project
39
-
4. Run in terminal: ```npm install```
40
-
5. Then: ```npm start```
41
-
6. Navigate to `http://localhost:3000/`
42
-
7. (optional) Run in terminal `npm i -g cross-env`
70
+
## Documentation
71
+
The documentation for the Material Dashboard React is hosted at our [website](https://demos.creative-tim.com/material-dashboard-react/#/documentation/tutorial).
43
72
44
-
### What's included
73
+
74
+
## File Structure
45
75
46
76
Within the download you'll find the following directories and files:
47
77
@@ -67,6 +97,7 @@ material-dashboard-react
67
97
├── assets
68
98
│ ├── css
69
99
│ │ └── material-dashboard-react.css
100
+
│ ├── github
70
101
│ ├── img
71
102
│ │ └── faces
72
103
│ └── jss
@@ -167,9 +198,41 @@ material-dashboard-react
167
198
└── UserProfile.jsx
168
199
```
169
200
201
+
## Browser Support
202
+
203
+
At present, we officially aim to support the last two versions of the following browsers:
-[Material Kit React - For Front End Development](https://www.creative-tim.com/product/material-kit-react?ref=github-mdr-free)
216
+
217
+
## Reporting Issues
218
+
We use GitHub Issues as the official bug tracker for the Material Dashboard React. Here are some advices for our users that want to report an issue:
219
+
220
+
1. Make sure that you are using the latest version of the Material Dashboard React. Check the CHANGELOG from your dashboard on our [website](https://www.creative-tim.com/).
221
+
2. Providing us reproducible steps for the issue will shorten the time it takes for it to be fixed.
222
+
3. Some issues may be browser specific, so specifying in what browser you encountered the issue might help.
223
+
224
+
## Technical Support or Questions
225
+
226
+
If you have questions or need help integrating the product please [contact us](https://www.creative-tim.com/contact-us) instead of opening an issue.
227
+
228
+
## Licensing
229
+
230
+
- Copyright 2018 Creative Tim (https://www.creative-tim.com)
231
+
- Licensed under MIT (https://github.com/creativetimofficial/material-dashboard-react/blob/master/LICENSE.md)
232
+
170
233
## Useful Links
171
234
172
-
More products from Creative Tim: <https://www.creative-tim.com/bootstrap-themes>
235
+
More products from Creative Tim: <https://www.creative-tim.com/products>
0 commit comments