<p align="center">
  <a href="https://coreui.io/">
    <img
      src="https://coreui.io/images/brand/coreui-signet.svg"
      alt="CoreUI logo"
      width="200"
    />
  </a>
</p>

<h2 align="center">CoreUI Pro for Angular</h3>

<p align="center">
  Angular Components Library built on top of Bootstrap 5.3 and TypeScript 5.4.
  <br>
  <a href="https://coreui.io/angular/docs/"><strong>Explore CoreUI for Angular docs »</strong></a>
  <br>
  <br>
  <a href="https://github.com/coreui/coreui-angular-pro/issues/new?template=bug_report.md">Report a bug</a>
  ·
  <a href="https://github.com/coreui/coreui-angular-pro/issues/new?template=feature_request.md">Request a feature</a>
  ·
  <a href="https://blog.coreui.io/">Blog</a>
</p>

## Status

![angular][angular-badge]
[![npm-coreui-angular-v5-ng18][npm-coreui-angular-badge-v5-ng18]][npm-coreui-angular]
[![npm-coreui-angular-latest][npm-coreui-angular-badge-latest]][npm-coreui-angular]
[![npm-coreui-angular-next][npm-coreui-angular-badge-next]][npm-coreui-angular]
[![NPM downloads][npm-coreui-angular-download]][npm-coreui-angular]  
[![Build](https://github.com/coreui/coreui-angular/actions/workflows/build-check.yml/badge.svg)](https://github.com/coreui/coreui-angular/actions/workflows/build-check.yml)

[npm-coreui-angular-badge-v5-ng18]: https://img.shields.io/npm/v/@coreui/angular-pro/v5-ng18?style=flat-square&color=brightgreen
[npm-coreui-angular-badge-latest]: https://img.shields.io/npm/v/@coreui/angular-pro/latest?style=flat-square&color=blue
[npm-coreui-angular-badge-next]: https://img.shields.io/npm/v/@coreui/angular-pro/next?style=flat-square&color=yellow
[npm-coreui-angular]: https://www.npmjs.com/package/@coreui/angular-pro
[npm-coreui-angular-download]: https://img.shields.io/npm/dm/@coreui/angular.svg?style=flat-square
[angular-badge]: https://img.shields.io/badge/angular-^18.0.0-lightgrey.svg?style=flat-square&logo=angular

## Table of contents

- [Status](#status)
- [Table of contents](#table-of-contents)
- [Quick start](#quick-start)
  - [Prerequisites](#prerequisites)
        - [Node.js](#nodejs)
        - [Angular CLI](#angular-cli)
  - [Installation](#installation)
    - [CoreUI CSS files](#coreui-css-files)
      - [Installation](#installation-1)
      - [Basic usage](#basic-usage)
    - [Bootstrap CSS files](#bootstrap-css-files)
      - [Installation (optional)](#installation-optional)
- [Template](#template)
- [Bugs and feature requests](#bugs-and-feature-requests)
- [Documentation](#documentation)
- [Frameworks](#frameworks)
- [Templates](#templates)
- [Contributing](#contributing)
- [Community](#community)
- [Versioning](#versioning)
- [Creators](#creators)
- [Copyright and license](#copyright-and-license)

## Quick start

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

###### Node.js
[**Angular 18**](https://angular.dev/overview) requires `Node.js` LTS version `^18.19` or newer. 

- To check your version, run `node -v` in a terminal/console window.
- To get `Node.js`, go to [nodejs.org](https://nodejs.org/).

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

```bash
npm install -g @angular/cli
```

### Installation
Several quick start options are available (pick one):

- [Download the latest release](https://github.com/coreui/coreui-angular-pro/)
- Clone the repo: `git clone https://github.com/coreui/coreui-angular-pro.git`
- Install with [npm](https://www.npmjs.com/): `npm install @coreui/angular @coreui/icons-angular @coreui/coreui`

Read the [Getting started page](https://coreui.io/angular/docs/) for information on the framework contents, templates and examples, and more.

#### CoreUI CSS files

##### Installation

```bash
npm install @coreui/coreui --save
```

##### Basic usage

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

#### Bootstrap CSS files

##### Installation (optional)

```bash
npm install bootstrap
```

## Template

* [CoreUI Free Angular Admin Template](https://github.com/coreui/coreui-free-angular-admin-template)
* 💪  [CoreUI Pro Angular Admin Template](https://coreui.io/angular/)

## Bugs and feature requests

Have a bug or a feature request? Please first read the [issue guidelines](https://github.com/coreui/coreui-angular-pro/blob/main/.github/CONTRIBUTING.md#using-the-issue-tracker) and search for existing and closed issues. If your problem or idea is not addressed yet, [please open a new issue](https://github.com/coreui/coreui-angular-pro/issues/new).

## Documentation

The documentation for the CoreUI & CoreUI PRO is hosted at our website [CoreUI for Angular](https://coreui.io/angular/docs/)

## Frameworks

CoreUI supports the most popular frameworks.

- [CoreUI for Bootstap(Vanilla JS)](https://github.com/coreui/coreui)
- [CoreUI for React](https://github.com/coreui/coreui-react)
- [CoreUI for Vue](https://github.com/coreui/coreui-vue)

## Templates

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

- [Angular Admin Template](https://coreui.io/angular)
- [Bootstrap Admin Template](https://coreui.io/)
- [React Admin Template](https://coreui.io/react)
- [Vue Admin Template](https://coreui.io/vue)

## Contributing

Please read through our [contributing guidelines](https://github.com/coreui/coreui-angular-pro/blob/main/.github/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-angular-pro/blob/main/.editorconfig) 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](https://blog.coreui.io/).

You can also follow [@core_ui on Twitter](https://twitter.com/core_ui).

## Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, CoreUI is maintained under [the Semantic Versioning guidelines](http://semver.org/).

See [the Releases section of our project](https://github.com/coreui/coreui-angular-pro/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>

**The CoreUI Team**

- <https://github.com/orgs/coreui/people>

## Copyright and license

Copyright 2017-2024 creativeLabs Łukasz Holeczek.

This is proprietary software. To use it, you have to obtain a commercial license.

