You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 6.9KB

4 jaren geleden
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177
  1. [![@coreui coreui](https://img.shields.io/badge/@coreui%20-coreui-lightgrey.svg?style=flat-square)](https://github.com/coreui/coreui)
  2. [![npm package][npm-coreui-badge]][npm-coreui]
  3. [![NPM downloads][npm-coreui-download]][npm-coreui]
  4. [![@coreui react](https://img.shields.io/badge/@coreui%20-react-lightgrey.svg?style=flat-square)](https://github.com/coreui/react)
  5. [![npm package][npm-coreui-react-badge]][npm-coreui-react]
  6. [![NPM downloads][npm-coreui-react-download]][npm-coreui-react]
  7. [![npm next][npm-next]][npm]
  8. [npm-coreui]: https://www.npmjs.com/package/@coreui/coreui
  9. [npm-coreui-badge]: https://img.shields.io/npm/v/@coreui/coreui.png?style=flat-square
  10. [npm-coreui-download]: https://img.shields.io/npm/dm/@coreui/coreui.svg?style=flat-square
  11. [npm-coreui-react]: https://www.npmjs.com/package/@coreui/react
  12. [npm-coreui-react-badge]: https://img.shields.io/npm/v/@coreui/react.png?style=flat-square
  13. [npm-coreui-react-download]: https://img.shields.io/npm/dm/@coreui/react.svg?style=flat-square
  14. [npm-next]: https://img.shields.io/npm/v/@coreui/react/next.png?style=flat-square
  15. [npm]: https://www.npmjs.com/package/@coreui/react
  16. # CoreUI Free React Admin Template v3
  17. CoreUI is meant to be the UX game changer. Pure & transparent code is devoid of redundant components, so the app is light enough to offer ultimate user experience. This means mobile devices also, where the navigation is just as easy and intuitive as on a desktop or laptop. The CoreUI Layout API lets you customize your project for almost any device – be it Mobile, Web or WebApp – CoreUI covers them all!
  18. ## Table of Contents
  19. * [Versions](#versions)
  20. * [CoreUI Pro](#coreui-pro)
  21. * [Installation](#installation)
  22. * [Basic usage](#create-react-app)
  23. * [What's included](#whats-included)
  24. * [Documentation](#documentation)
  25. * [Versioning](#versioning)
  26. * [Creators](#creators)
  27. * [Community](#community)
  28. * [Copyright and License](#copyright-and-license)
  29. ## Versions
  30. * [CoreUI Free Bootstrap Admin Template](https://github.com/coreui/coreui-free-bootstrap-admin-template)
  31. * [CoreUI Free Angular 9+ Admin Template](https://github.com/coreui/coreui-free-angular-admin-template)
  32. * [CoreUI Free React.js Admin Template](https://github.com/coreui/coreui-free-react-admin-template)
  33. * [CoreUI Free Vue.js Admin Template](https://github.com/coreui/coreui-free-vue-admin-template)
  34. * [CoreUI Free Laravel Admin Template](https://github.com/coreui/coreui-free-laravel-admin-template)
  35. * [CoreUI Free Vue.js + Laravel Admin Template](https://github.com/coreui/coreui-free-vue-laravel-admin-template)
  36. ## CoreUI Pro
  37. **Only customers with [Enterpise Membership Plan](https://coreui.io/pro/#buy) have access to private github CoreUI Pro repository.**
  38. * 💪 [CoreUI Pro Bootstrap Admin Template](https://coreui.io/pro/)
  39. * 💪 [CoreUI Pro Angular 9+ Admin Template](https://coreui.io/pro/angular)
  40. * 💪 [CoreUI Pro React Admin Template](https://coreui.io/pro/react)
  41. * 💪 [CoreUI Pro Vue Admin Template](https://coreui.io/pro/vue)
  42. * 💪 [CoreUI Pro Laravel Admin Template](https://coreui.io/pro/laravel/)
  43. * 💪 [CoreUI Pro Vue.js + Laravel Admin Template](https://coreui.io/pro/vue-laravel/)
  44. ## Installation
  45. ### Clone repo
  46. ``` bash
  47. # clone the repo
  48. $ git clone https://github.com/coreui/coreui-free-react-admin-template.git my-project
  49. # go into app's directory
  50. $ cd my-project
  51. # checkout stable version
  52. $ git checkout master
  53. # install app's dependencies
  54. $ npm install
  55. ```
  56. ### Copy and Paste
  57. Copy all your files to your project folder and then,
  58. ``` bash
  59. # go into app's directory
  60. $ cd my-project
  61. # install app's dependencies
  62. $ npm install
  63. ```
  64. ## Create React App
  65. This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app)
  66. see also:
  67. [CRA docs](https://create-react-app.dev/docs/getting-started)
  68. ### Basic usage
  69. ``` bash
  70. # dev server with hot reload at http://localhost:3000
  71. $ npm start
  72. ```
  73. Navigate to [http://localhost:3000](http://localhost:3000). The app will automatically reload if you change any of the source files.
  74. ### Build
  75. Run `build` to build the project. The build artifacts will be stored in the `build/` directory.
  76. ```bash
  77. # build for production with minification
  78. $ npm run build
  79. ```
  80. ## What's included
  81. Within the download you'll find the following directories and files, logically grouping common assets and providing both compiled and minified variations. You'll see something like this:
  82. ```
  83. CoreUI-React#v3.0.0
  84. ├── public/ #static files
  85. │ └── index.html #html template
  86. ├── src/ #project root
  87. │ ├── assets/ #assets - js icons object
  88. │ ├── containers/ #container source - template layout
  89. | │ ├── _nav.js #sidebar config
  90. | │ └── ...
  91. │ ├── scss/ #user scss/css source
  92. │ ├── views/ #views source
  93. │ ├── App.js
  94. │ ├── App.test.js
  95. │ ├── polyfill.js
  96. │ ├── index.js
  97. │ ├── routes.js #routes config
  98. │ └── store.js #template state example
  99. └── package.json
  100. ```
  101. ## Documentation
  102. The documentation for the CoreUI Admin Template is hosted at our website [CoreUI for React](https://coreui.io/react/)
  103. ### :film_strip: How to setup coreui react theme in laravel. Video tutorial available [here](https://youtu.be/HVVpbpNUJ8M)
  104. ## Versioning
  105. For transparency into our release cycle and in striving to maintain backward compatibility, CoreUI Free Admin Template is maintained under [the Semantic Versioning guidelines](http://semver.org/).
  106. See [the Releases section of our project](https://github.com/coreui/coreui-free-react-admin-template/releases) for changelogs for each release version.
  107. ## Creators
  108. **Łukasz Holeczek**
  109. * <https://twitter.com/lukaszholeczek>
  110. * <https://github.com/mrholek>
  111. * <https://github.com/coreui>
  112. **CoreUI team**
  113. * https://github.com/orgs/coreui/people
  114. ## Community
  115. Get updates on CoreUI's development and chat with the project maintainers and community members.
  116. - Follow [@core_ui on Twitter](https://twitter.com/core_ui).
  117. - Read and subscribe to [CoreUI Blog](https://coreui.ui/blog/).
  118. ## Copyright and License
  119. copyright 2020 creativeLabs Łukasz Holeczek.
  120. Code released under [the MIT license](https://github.com/coreui/coreui-free-react-admin-template/blob/master/LICENSE).
  121. There is only one limitation you can't can’t re-distribute the CoreUI as stock. You can’t do this if you modify the CoreUI. In past we faced some problems with persons who tried to sell CoreUI based templates.
  122. ## Support CoreUI Development
  123. CoreUI is an MIT licensed open source project and completely free to use. However, the amount of effort needed to maintain and develop new features for the project is not sustainable without proper financial backing. You can support development by buying [CoreUI Pro Version](https://coreui.io/pro/).
  124. We're also open to conversations regarding custom sponsorship / consulting arrangements. Get in touch on [Twitter](https://twitter.com/lukaszholeczek).