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.
178 lines
9.6 KiB
178 lines
9.6 KiB
3 years ago
|
[](https://github.com/coreui/coreui)
|
||
|
|
[![npm package][npm-coreui-badge]][npm-coreui]
|
||
|
|
[![NPM downloads][npm-coreui-download]][npm-coreui]
|
||
|
|
[](https://github.com/coreui/react)
|
||
|
|
[![npm package][npm-coreui-react-badge]][npm-coreui-react]
|
||
|
|
[![NPM downloads][npm-coreui-react-download]][npm-coreui-react]
|
||
|
|
|
||
|
|
[npm-coreui]: https://www.npmjs.com/package/@coreui/coreui
|
||
|
|
[npm-coreui-badge]: https://img.shields.io/npm/v/@coreui/coreui.png?style=flat-square
|
||
|
|
[npm-coreui-download]: https://img.shields.io/npm/dm/@coreui/coreui.svg?style=flat-square
|
||
|
|
[npm-coreui-react]: https://www.npmjs.com/package/@coreui/react
|
||
|
|
[npm-coreui-react-badge]: https://img.shields.io/npm/v/@coreui/react.png?style=flat-square
|
||
|
|
[npm-coreui-react-download]: https://img.shields.io/npm/dm/@coreui/react.svg?style=flat-square
|
||
|
|
|
||
|
|
# CoreUI Free React Admin Template v2 [](https://twitter.com/intent/tweet?text=CoreUI%20-%20Free%20React%20Admin%20Template%20&url=https://coreui.io/react/&hashtags=bootstrap,admin,template,dashboard,panel,free,angular,react,vue)
|
||
|
|
|
||
|
|
Please help us on [Product Hunt](https://www.producthunt.com/posts/coreui-open-source-bootstrap-4-admin-template-with-angular-2-react-js-vue-js-support) and [Designer News](https://www.designernews.co/stories/81127). Thanks in advance!
|
||
|
|
|
||
|
|
Curious why I decided to create CoreUI? Please read this article: [Jack of all trades, master of none. Why Bootstrap Admin Templates suck.](https://medium.com/@lukaszholeczek/jack-of-all-trades-master-of-none-5ea53ef8a1f#.7eqx1bcd8)
|
||
|
|
|
||
|
|
CoreUI is an Open Source Bootstrap Admin Template. But CoreUI is not just another Admin Template. It goes way beyond hitherto admin templates thanks to transparent code and file structure. And if that's not enough, let’s just add that CoreUI consists bunch of unique features and over 1000 high quality icons.
|
||
|
|
|
||
|
|
CoreUI is based on Bootstrap 4 and offers 6 versions: [HTML5 AJAX](https://github.com/coreui/free-bootstrap-admin-template-ajax), [HTML5](https://github.com/coreui/free-angular-admin-template), [Angular 2+](https://github.com/coreui/free-angular-admin-template), [React.js](https://github.com/coreui/free-react-admin-template) & [Vue.js](https://github.com/coreui/free-vue-admin-template), [.NET Core 2](https://github.com/coreui/free-dotnet-admin-template).
|
||
|
|
|
||
|
|
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!
|
||
|
|
|
||
|
|
## Table of Contents
|
||
|
|
|
||
|
|
* [Versions](#versions)
|
||
|
|
* [CoreUI Pro](#coreui-pro)
|
||
|
|
* [Admin Templates built on top of CoreUI Pro](#admin-templates-built-on-top-of-coreui-pro)
|
||
|
|
* [Installation](#installation)
|
||
|
|
* [Usage](#usage)
|
||
|
|
* [What's included](#whats-included)
|
||
|
|
* [Documentation](#documentation)
|
||
|
|
* [Contributing](#contributing)
|
||
|
|
* [Versioning](#versioning)
|
||
|
|
* [Creators](#creators)
|
||
|
|
* [Community](#community)
|
||
|
|
* [Community Projects](#community-projects)
|
||
|
|
* [License](#license)
|
||
|
|
* [Support CoreUI Development](#support-coreui-development)
|
||
|
|
|
||
|
|
## Versions
|
||
|
|
|
||
|
|
* [CoreUI Free Bootstrap Admin Template](https://github.com/coreui/coreui-free-bootstrap-admin-template)
|
||
|
|
* [CoreUI Free Bootstrap Admin Template (Ajax)](https://github.com/coreui/coreui-free-bootstrap-admin-template-ajax)
|
||
|
|
* [CoreUI Free Angular 2+ Admin Template](https://github.com/coreui/coreui-free-angular-admin-template)
|
||
|
|
* 🚧 CoreUI Free .NET Core 2 Admin Template (Available Soon)
|
||
|
|
* [CoreUI Free React.js Admin Template](https://github.com/coreui/coreui-free-react-admin-template)
|
||
|
|
* [CoreUI Free Vue.js Admin Template](https://github.com/coreui/coreui-free-vue-admin-template)
|
||
|
|
|
||
|
|
## CoreUI Pro
|
||
|
|
|
||
|
|
* 💪 [CoreUI Pro Bootstrap Admin Template](https://coreui.io/pro/)
|
||
|
|
* 💪 [CoreUI Pro Bootstrap Admin Template (Ajax)](https://coreui.io/pro/)
|
||
|
|
* 💪 [CoreUI Pro Angular Admin Template](https://coreui.io/pro/angular)
|
||
|
|
* 💪 [CoreUI Pro React Admin Template](https://coreui.io/pro/react)
|
||
|
|
* 💪 [CoreUI Pro Vue Admin Template](https://coreui.io/pro/vue)
|
||
|
|
|
||
|
|
## Admin Templates built on top of CoreUI Pro
|
||
|
|
|
||
|
|
| CoreUI Pro | Prime | Root | Alba | Leaf |
|
||
|
|
| --- | --- | --- | --- | --- |
|
||
|
|
| [](https://coreui.io/pro/react/) | [](https://genesisui.com/admin-templates/reactjs/prime/?support=1) | [](https://genesisui.com/admin-templates/reactjs/root/?support=1) | [](https://genesisui.com/admin-templates/reactjs/alba/?support=1) | [](https://genesisui.com/admin-templates/reactjs/leaf/?support=1)
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
``` bash
|
||
|
|
# clone the repo
|
||
|
|
$ git clone https://github.com/coreui/coreui-free-react-admin-template.git my-project
|
||
|
|
|
||
|
|
# go into app's directory
|
||
|
|
$ cd my-project
|
||
|
|
|
||
|
|
# install app's dependencies
|
||
|
|
$ npm install
|
||
|
|
```
|
||
|
|
|
||
|
|
## Create React App
|
||
|
|
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app)
|
||
|
|
|
||
|
|
see also:
|
||
|
|
[User Guide](CRA.md)
|
||
|
|
|
||
|
|
### Basic usage
|
||
|
|
|
||
|
|
``` bash
|
||
|
|
# dev server with hot reload at http://localhost:3000
|
||
|
|
$ npm start
|
||
|
|
```
|
||
|
|
|
||
|
|
Navigate to [http://localhost:3000](http://localhost:3000). The app will automatically reload if you change any of the source files.
|
||
|
|
|
||
|
|
### Build
|
||
|
|
|
||
|
|
Run `build` to build the project. The build artifacts will be stored in the `build/` directory.
|
||
|
|
|
||
|
|
```bash
|
||
|
|
# build for production with minification
|
||
|
|
$ npm run build
|
||
|
|
```
|
||
|
|
|
||
|
|
## What's included
|
||
|
|
|
||
|
|
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:
|
||
|
|
|
||
|
|
```
|
||
|
|
CoreUI-React#v2.0.0
|
||
|
|
├── public/ #static files
|
||
|
|
│ ├── assets/ #assets
|
||
|
|
│ └── index.html #html template
|
||
|
|
│
|
||
|
|
├── src/ #project root
|
||
|
|
│ ├── containers/ #container source
|
||
|
|
│ ├── scss/ #user scss/css source
|
||
|
|
│ ├── views/ #views source
|
||
|
|
│ ├── App.js
|
||
|
|
│ ├── App.test.js
|
||
|
|
│ ├── index.js
|
||
|
|
│ ├── _nav.js #sidebar config
|
||
|
|
│ └── routes.js #routes config
|
||
|
|
│
|
||
|
|
└── package.json
|
||
|
|
```
|
||
|
|
|
||
|
|
## Documentation
|
||
|
|
|
||
|
|
The documentation for the CoreUI Admin Template is hosted at our website [CoreUI for React](https://coreui.io/react/)
|
||
|
|
|
||
|
|
|
||
|
|
## Contributing
|
||
|
|
|
||
|
|
Please read through our [contributing guidelines](https://github.com/coreui/coreui-free-react-admin-template/blob/master/CONTRIBUTING.md). Included are directions for opening issues, coding standards, and notes on development.
|
||
|
|
|
||
|
|
Editor preferences are available in the [editor config](https://github.com/coreui/coreui-free-react-admin-template/blob/master/.editorconfig) for easy use in common text editors. Read more and download plugins at <http://editorconfig.org>.
|
||
|
|
|
||
|
|
## Versioning
|
||
|
|
|
||
|
|
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/).
|
||
|
|
|
||
|
|
See [the Releases section of our project](https://github.com/coreui/coreui-free-react-admin-template/releases) for changelogs for each release version.
|
||
|
|
|
||
|
|
## Creators
|
||
|
|
|
||
|
|
**Łukasz Holeczek**
|
||
|
|
* <https://twitter.com/lukaszholeczek>
|
||
|
|
* <https://github.com/mrholek>
|
||
|
|
|
||
|
|
**Andrzej Kopański**
|
||
|
|
* <https://github.com/xidedix>
|
||
|
|
|
||
|
|
## Community
|
||
|
|
|
||
|
|
Get updates on CoreUI's development and chat with the project maintainers and community members.
|
||
|
|
|
||
|
|
- Follow [@core_ui on Twitter](https://twitter.com/core_ui).
|
||
|
|
- Read and subscribe to [CoreUI Blog](https://coreui.ui/blog/).
|
||
|
|
|
||
|
|
### Community Projects
|
||
|
|
|
||
|
|
Some of projects created by community but not maintained by CoreUI team.
|
||
|
|
|
||
|
|
* [NuxtJS + Vue CoreUI](https://github.com/muhibbudins/nuxt-coreui)
|
||
|
|
* [Colmena](https://github.com/colmena/colmena)
|
||
|
|
* [mvelosop/AspNetCore2CoreUI](https://github.com/mvelosop/AspNetCore2CoreUI)
|
||
|
|
|
||
|
|
## Copyright and license
|
||
|
|
|
||
|
|
copyright 2018 creativeLabs Łukasz Holeczek. Code released under [the MIT license](LICENSE).
|
||
|
|
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.
|
||
|
|
|
||
|
|
## Support CoreUI Development
|
||
|
|
|
||
|
|
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 donating on [PayPal](https://www.paypal.me/holeczek), buying [CoreUI Pro Version](https://coreui.io/pro) or buying one of our [premium admin templates](https://genesisui.com/?support=1).
|
||
|
|
|
||
|
|
As of now I am exploring the possibility of working on CoreUI fulltime - if you are a business that is building core products using CoreUI, I am also open to conversations regarding custom sponsorship / consulting arrangements. Get in touch on [Twitter](https://twitter.com/lukaszholeczek).
|