Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/coreui/coreui-angular

CoreUI Components Library for Angular https://coreui.io/angular/docs/
https://github.com/coreui/coreui-angular

angular angular-components bootstrap-5 components coreui ui-components

Last synced: about 1 month ago
JSON representation

CoreUI Components Library for Angular https://coreui.io/angular/docs/

Awesome Lists containing this project

README 

        


  

    CoreUI logo

  




CoreUI for Angular





  Angular Components Library built on top of Bootstrap 5.3 and TypeScript 5.4.

  


  Explore CoreUI for Angular docs »

  


  


  Report a bug

  ·

  Request a feature

  ·

  Blog




## 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/v5-ng18?style=flat-square&color=brightgreen

[npm-coreui-angular-badge-latest]: https://img.shields.io/npm/v/@coreui/angular/latest?style=flat-square&color=brightgreen

[npm-coreui-angular-badge-next]: https://img.shields.io/npm/v/@coreui/angular/next?style=flat-square&color=red

[npm-coreui-angular]: https://www.npmjs.com/package/@coreui/angular

[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.2.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)

- [Templates](#templates)

- [Bugs and feature requests](#bugs-and-feature-requests)

- [Documentation](#documentation)

- [Frameworks](#frameworks)

- [Templates](#templates)

- [Contributing](#contributing)

- [Community](#community)

- [Versioning](#versioning)

- [Creators](#creators)

- [Support CoreUI Development](#support-coreui-development)

- [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):

- Add CoreUI to your Angular project:

  - Install with [Angular CLI](https://angular.dev/cli/add): `ng add @coreui/angular`

  - Install with [npm](https://www.npmjs.com/): `npm install @coreui/angular @coreui/icons-angular @coreui/coreui`

- Get the source code:

  - [Download the latest release](https://github.com/coreui/coreui-angular/)

  - Clone the repo: `git clone https://github.com/coreui/coreui-angular.git`



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

```



## Templates



* [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/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/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/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/blob/main/.editorconfig) for easy use in common text editors. Read more and download plugins at .



## 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/releases) for changelogs for each release version.



## Creators



**Łukasz Holeczek**



- 

- 



**Andrzej Kopański**



- 



**The CoreUI Team**



- 



## 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](https://coreui.io/pricing/) or by becoming a sponsor via [Open Collective](https://opencollective.com/coreui/).



### Platinum Sponsors



Support this project by [becoming a Platinum Sponsor](https://opencollective.com/coreui/contribute/platinum-sponsor-40959/). A large company logo will be added here with a link to your website.






### Gold Sponsors



Support this project by [becoming a Gold Sponsor](https://opencollective.com/coreui/contribute/gold-sponsor-40960/). A big company logo will be added here with a link to your website.



 



### Silver Sponsors



Support this project by [becoming a Silver Sponsor](https://opencollective.com/coreui/contribute/silver-sponsor-40967/). A medium company logo will be added here with a link to your website.






### Bronze Sponsors



Support this project by [becoming a Bronze Sponsor](https://opencollective.com/coreui/contribute/bronze-sponsor-40966/). 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](https://opencollective.com/coreui/contribute/backer-40965/).






## Copyright and license



Copyright 2024 creativeLabs Łukasz Holeczek. Code released under the [MIT License](https://github.com/coreui/coreui-angular/blob/main/LICENSE). Docs released under [Creative Commons](https://creativecommons.org/licenses/by/3.0/).