Go to file
2021-10-20 21:44:56 +02:00
.github docs: update md files; 2021-10-20 14:49:27 +02:00
public release: v4.0.0-rc.4 2021-10-04 18:32:10 +02:00
src refactor: update examples 2021-10-20 21:44:56 +02:00
.browserslistrc build: update build tools 2021-05-24 14:07:16 +02:00
.editorconfig chore: add editor config 2018-04-16 13:09:27 +02:00
.env chore: move to Create React App 2.0 2018-10-02 16:31:00 +02:00
.eslintrc.js build: update build tools 2021-05-24 14:07:16 +02:00
.gitattributes fix: enforce Unix newlines 2021-05-25 23:26:29 +02:00
.gitignore chore: .gitignore cleanup 2020-11-26 22:29:50 +01:00
.prettierignore refactor: update to v4 2021-04-13 00:38:48 +02:00
.prettierrc.js refactor: update to v4 2021-04-13 00:38:48 +02:00
CHANGELOG.md chore: 3.2.0 release for React 17 2020-12-14 18:15:33 +01:00
jsconfig.json refactor: add reusable folder with DocsLink component 2020-08-12 15:50:40 +02:00
LICENSE chore: update date 2021-05-18 23:32:09 +02:00
migration.md docs: update migration guide 2021-08-01 21:34:08 +02:00
package.json chore: update dependencies and devDependencies 2021-10-20 13:53:21 +02:00
README.md docs: update md files 2021-08-13 21:30:41 +02:00
yarn.lock chore: update dependencies and devDependencies 2021-10-20 13:53:21 +02:00

@coreui coreui npm package NPM downloads
@coreui react npm package NPM downloads
npm next

CoreUI Free React Admin Template v4

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

Only customers with Enterpise Membership Plan have access to private github CoreUI Pro repository.

Quick Start

Instalation

$ 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
│   └── index.html   # html template
│
├── 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 
│
└── package.json

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

CoreUI team

Community

Get updates on CoreUI's development and chat with the project maintainers and community members.

copyright 2021 creativeLabs Łukasz Holeczek.

Code released under the MIT license. There is only one limitation you can't cant re-distribute the CoreUI as stock. You cant 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 buying CoreUI Pro Version.

We're also open to conversations regarding custom sponsorship / consulting arrangements. Get in touch on Twitter.