|
1 |
| -This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). |
| 1 | +## React Material Template — material admin dashboard template |
| 2 | +built with [React](https://facebook.github.io/react/), [Material-UI](https://material-ui.com), [React Router](https://reacttraining.com/react-router/) |
| 3 | +[Redux](http://redux.js.org/) |
2 | 4 |
|
3 |
| -## Available Scripts |
| 5 | +Demo](https://flatlogic.com/admin-dashboards/react-dashboard/demo). Use following credentials: user/password. |
4 | 6 |
|
5 |
| -In the project directory, you can run: |
| 7 | + |
6 | 8 |
|
7 |
| -### `npm start` |
8 | 9 |
|
9 |
| -Runs the app in the development mode.<br> |
10 |
| -Open [http://localhost:3000](http://localhost:3000) to view it in the browser. |
| 10 | +## Features |
| 11 | +* React |
| 12 | +* Mobile friendly layout (responsive) |
| 13 | +* Create-react-app under the hood |
| 14 | +* React Router |
| 15 | +* Material-UI |
| 16 | +* Modular Architecture |
| 17 | +* CSS-in-JS styles |
| 18 | +* Webpack build |
| 19 | +* Stylish, clean, responsive layout |
| 20 | +* Authentication |
11 | 21 |
|
12 |
| -The page will reload if you make edits.<br> |
13 |
| -You will also see any lint errors in the console. |
| 22 | +## Quick Start |
14 | 23 |
|
15 |
| -### `npm test` |
| 24 | +#### 1. Get the latest version |
16 | 25 |
|
17 |
| -Launches the test runner in the interactive watch mode.<br> |
18 |
| -See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. |
| 26 | +You can start by cloning the latest version of React Dashboard on your |
| 27 | +local machine by running: |
19 | 28 |
|
20 |
| -### `npm run build` |
| 29 | +```shell |
| 30 | +$ git clone https://github.com/flatlogic/react-material-template.git MyApp |
| 31 | +$ cd MyApp |
| 32 | +``` |
21 | 33 |
|
22 |
| -Builds the app for production to the `build` folder.<br> |
23 |
| -It correctly bundles React in production mode and optimizes the build for the best performance. |
24 |
| - |
25 |
| -The build is minified and the filenames include the hashes.<br> |
26 |
| -Your app is ready to be deployed! |
27 |
| - |
28 |
| -See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. |
29 |
| - |
30 |
| -### `npm run eject` |
31 |
| - |
32 |
| -**Note: this is a one-way operation. Once you `eject`, you can’t go back!** |
33 |
| - |
34 |
| -If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project. |
| 34 | +#### 2. Run `yarn install` |
35 | 35 |
|
36 |
| -Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own. |
| 36 | +This will install both run-time project dependencies and developer tools listed |
| 37 | +in [package.json](../package.json) file. |
37 | 38 |
|
38 |
| -You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it. |
| 39 | +#### 3. Run `yarn start` |
39 | 40 |
|
40 |
| -## Learn More |
| 41 | +Runs the app in the development mode. |
41 | 42 |
|
42 |
| -You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). |
| 43 | +Open http://localhost:3000 to view it in the browser. Whenever you modify any of the source files inside the `/src` folder, |
| 44 | +the module bundler ([Webpack](http://webpack.github.io/)) will recompile the |
| 45 | +app on the fly and refresh all the connected browsers. |
43 | 46 |
|
44 |
| -To learn React, check out the [React documentation](https://reactjs.org/). |
| 47 | +#### 4. Run `yarn build` |
45 | 48 |
|
46 |
| -### Code Splitting |
47 |
| - |
48 |
| -This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting |
49 |
| - |
50 |
| -### Analyzing the Bundle Size |
51 |
| - |
52 |
| -This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size |
53 |
| - |
54 |
| -### Making a Progressive Web App |
55 |
| - |
56 |
| -This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app |
| 49 | +Builds the app for production to the build folder. |
| 50 | +It correctly bundles React in production mode and optimizes the build for the best performance. |
57 | 51 |
|
58 |
| -### Advanced Configuration |
| 52 | +The build is minified and the filenames include the hashes. |
| 53 | +Your app is ready to be deployed! |
59 | 54 |
|
60 |
| -This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration |
| 55 | +## Support |
| 56 | +For any additional information please refer to [Flatlogic homepage](https://flatlogic.com). |
61 | 57 |
|
62 |
| -### Deployment |
| 58 | +## How can I support developers? |
| 59 | +- Star our GitHub repo :star: |
| 60 | +- [Tweet about it](https://twitter.com/intent/tweet?text=Amazing%20dashboard%20built%20with%20NodeJS,%20React%20and%20Bootstrap!&url=https://github.com/flatlogic/react-material-template&via=flatlogic). |
| 61 | +- Create pull requests, submit bugs, suggest new features or documentation updates :wrench: |
| 62 | +- Follow [@flatlogic on Twitter](https://twitter.com/flatlogic). |
| 63 | +- Subscribe to Flatlogic newsletter at [flatlogic.com](https://flatlogic.com/) |
| 64 | +- Like our page on [Facebook](https://www.facebook.com/flatlogic/) :thumbsup: |
63 | 65 |
|
64 |
| -This section has moved here: https://facebook.github.io/create-react-app/docs/deployment |
| 66 | +## Premium themes |
| 67 | +Looking for premium themes and templates? Check out more [admin dashboard templates at flatlogic.com](https://flatlogic.com/admin-dashboards). |
65 | 68 |
|
66 |
| -### `npm run build` fails to minify |
| 69 | +## License |
67 | 70 |
|
68 |
| -This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify |
| 71 | +[MIT](https://github.com/flatlogic/react-material-dashboard/blob/master/LICENSE.txt). |
0 commit comments