Status

Table of contents

• Status
• Quick start
• Templates
• Bugs and feature requests
• Documentation
• Frameworks
• Templates
• Contributing
• Community
• Versioning
• Creators
• Support CoreUI Development
• Copyright and license

Quick start

Prerequisites

Before you begin, make sure your development environment includes Node.js® and npm package manager.

Node.js

Angular 16.1 requires Node.js LTS version ^16.14 or ^18.10.

• To check your version, run node -v in a terminal/console window.
• To get Node.js, go to nodejs.org.

Angular CLI

Install the Angular CLI globally using a terminal/console window.

npm install -g @angular/cli

Installation

Several quick start options are available (pick one):

• Download the latest release
• Clone the repo: git clone https://github.com/coreui/coreui-angular.git
• Install with npm: npm install @coreui/angular
• Install with yarn: yarn add @coreui/angular

Read the Getting started page for information on the framework contents, templates and examples, and more.

CoreUI CSS files

Installation

npm install @coreui/coreui --save

Basic usage

@import "@coreui/coreui/scss/coreui";

Bootstrap CSS files

Installation (optional)

npm install bootstrap

Templates

• CoreUI Free Angular Admin Template
• 💪 CoreUI Pro Angular Admin Template

Bugs and feature requests

Have a bug or a feature request? Please first read the issue guidelines and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

Documentation

The documentation for the CoreUI & CoreUI PRO is hosted at our website CoreUI for Angular

Frameworks

CoreUI supports most popular frameworks.

• CoreUI for Bootstap(Vanilla JS)
• CoreUI for React
• CoreUI for Vue

Templates

Fully featured, out-of-the-box, templates for your application based on CoreUI.

• Angular Admin Template
• Bootstrap Admin Template
• React Admin Template
• Vue Admin Template

Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

Editor preferences are available in the editor config for easy use in common text editors. Read more and download plugins at https://editorconfig.org/.

Community

Stay up to date on the development of CoreUI and reach out to the community with these helpful resources.

• Read and subscribe to The Official CoreUI Blog.

You can also follow @core_ui on Twitter.

Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, CoreUI 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

The CoreUI Team

• https://github.com/orgs/coreui/people

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.

Platinum Sponsors

Support this project by becoming a Platinum Sponsor. A large company logo will be added here with a link to your website.

Gold Sponsors

Support this project by becoming a Gold Sponsor. A big company logo will be added here with a link to your website.

Silver Sponsors

Support this project by becoming a Silver Sponsor. A medium company logo will be added here with a link to your website.

Bronze Sponsors

Support this project by becoming a Bronze Sponsor. The company avatar will show up here with a link to your OpenCollective Profile.

Backers

Thanks to all the backers and sponsors! Support this project by becoming a backer.

Copyright and license

Copyright 2023 creativeLabs Łukasz Holeczek. Code released under the MIT License. Docs released under Creative Commons.