137 lines
4.9 KiB
Markdown
137 lines
4.9 KiB
Markdown
[](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 next][npm-next]][npm]
|
||
|
||
[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
|
||
[npm-next]: https://img.shields.io/npm/v/@coreui/react/next.png?style=flat-square
|
||
[npm]: https://www.npmjs.com/package/@coreui/react
|
||
|
||
# CoreUI Free React Admin Template v3
|
||
|
||
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)
|
||
* [Installation](#installation)
|
||
* [Basic usage](#create-react-app)
|
||
* [What's included](#whats-included)
|
||
* [Documentation](#documentation)
|
||
* [Versioning](#versioning)
|
||
* [Creators](#creators)
|
||
* [Community](#community)
|
||
* [Copyright and License](#copyright-and-license)
|
||
|
||
## Versions
|
||
|
||
* [CoreUI Pro Bootstrap Admin Template](https://github.com/coreui/coreui-pro-bootstrap-admin-template)
|
||
* [CoreUI Pro Bootstrap Admin Template (Ajax)](https://github.com/coreui/coreui-pro-bootstrap-admin-template-ajax)
|
||
* [CoreUI Pro Angular 2+ Admin Template](https://github.com/coreui/coreui-pro-angular-admin-template)
|
||
* 🚧 CoreUI Pro .NET Core 2 Admin Template (Available Soon)
|
||
* [CoreUI Pro React.js Admin Template](https://github.com/coreui/coreui-pro-react-admin-template)
|
||
* [CoreUI Pro Vue.js Admin Template](https://github.com/coreui/coreui-pro-vue-admin-template)
|
||
|
||
**Only customers with [Membership Plan](https://coreui.io/pro/#buy) have access to private github repositories.**
|
||
|
||
## CoreUI Pro
|
||
|
||
* 💪 [CoreUI Pro Bootstrap Admin Template](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)
|
||
|
||
## Installation
|
||
|
||
### Clone repo
|
||
|
||
**Only customers with [Enterrise Membership Plan](https://coreui.io/pro/#buy) have access to private github repository.**
|
||
|
||
``` 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
|
||
```
|
||
|
||
### Copy and Paste
|
||
|
||
Copy all your files to your project folder and then,
|
||
|
||
``` bash
|
||
# 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
|
||
```
|
||
|
||
## Documentation
|
||
|
||
The documentation for the CoreUI Admin Template is hosted at our website [CoreUI for React](https://coreui.io/react/)
|
||
|
||
|
||
## 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>
|
||
|
||
**CoreUI team**
|
||
* https://github.com/orgs/coreui/people
|
||
|
||
## 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/).
|
||
|
||
|
||
## Copyright and License
|
||
|
||
copyright 2020 creativeLabs Łukasz Holeczek.
|