README.md

CoreUI Free React 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
• CoreUI PRO
• CoreUI PRO React Admin Templates
• Quick Start
• Installation
• Basic usage
• What's included
• Documentation
• Versioning
• Creators
• Community
• Support CoreUI Development
• Copyright and License

Versions

• CoreUI Free Bootstrap Admin Template
• CoreUI Free Angular Admin Template
• CoreUI Free React.js Admin Template (Vite)
• CoreUI Free React.js Admin Template (Create React App)
• CoreUI Free Vue.js Admin Template

CoreUI PRO

• 💪 CoreUI PRO Angular Admin Template
• 💪 CoreUI PRO Bootstrap Admin Template
• 💪 CoreUI PRO React Admin Template
• 💪 CoreUI PRO Vue Admin Template

CoreUI PRO React Admin Templates

Default Theme	Light Theme

Default Theme v3	Light Theme v3

Quick Start

• Download the latest release
• Clone the repo: git clone https://github.com/coreui/coreui-free-react-admin-template.git

Installation

$ npm install

or

$ yarn install

Basic usage

# dev server with hot reload at http://localhost:3000
$ npm start 

or

# dev server with hot reload at http://localhost:3000
$ yarn start

Navigate to 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.

# build for production with minification
$ npm run build

or

# build for production with minification
$ yarn 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-free-react-admin-template
├── public/          # static files
│   ├── favicon.ico
│   └── manifest.json
│
├── src/             # project root
│   ├── assets/      # images, icons, etc.
│   ├── components/  # common components - header, footer, sidebar, etc.
│   ├── layouts/     # layout containers
│   ├── scss/        # scss styles
│   ├── views/       # application views
│   ├── _nav.js      # sidebar navigation config
│   ├── App.js
│   ├── index.js
│   ├── routes.js    # routes config
│   └── store.js     # template state example 
│
├── index.html       # html template
├── ...
├── package.json
├── ...
└── vite.config.mjs  # vite config

Documentation

The documentation for the CoreUI Admin Template is hosted at our website CoreUI for 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.

See the Releases section of our project for changelogs for each release version.

Creators

Łukasz Holeczek

• https://twitter.com/lukaszholeczek
• https://github.com/mrholek

Andrzej Kopański

• https://github.com/xidedix

CoreUI Team

• https://twitter.com/core_ui
• https://github.com/coreui
• 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.
• Read and subscribe to CoreUI Blog.

Support CoreUI Development

CoreUI is an MIT-licensed open source project and is 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 the CoreUI PRO or by becoming a sponsor via Open Collective.

Copyright and License

copyright 2024 creativeLabs Łukasz Holeczek.

Code released under the MIT license.