Awesome
<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 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/issues/new?template=bug_report.md">Report a bug</a> · <a href="https://github.com/coreui/coreui-angular/issues/new?template=feature_request.md">Request a feature</a> · <a href="https://blog.coreui.io/">Blog</a> </p>Status
Table of contents
- Status
- Table of contents
- 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 18 requires Node.js LTS version ^18.19 or newer.
- To check your version, run
node -vin 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):
- Add CoreUI to your Angular project:
- Install with Angular CLI:
ng add @coreui/angular - Install with npm:
npm install @coreui/angular @coreui/icons-angular @coreui/coreui
- Install with Angular CLI:
- Get the source code:
- Download the latest release
- Clone the repo:
git clone https://github.com/coreui/coreui-angular.git
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
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 the most popular frameworks.
Templates
Fully featured, out-of-the-box, templates for your application based on CoreUI.
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
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 or by becoming a sponsor via Open Collective.
<!--- StartOpenCollectiveBackers -->Platinum Sponsors
Support this project by becoming a Platinum Sponsor. A large company logo will be added here with a link to your website.
<a href="https://opencollective.com/coreui/contribute/platinum-sponsor-40959/checkout"><img src="https://opencollective.com/coreui/tiers/platinum-sponsor/0/avatar.svg?avatarHeight=100"></a>
Gold Sponsors
Support this project by becoming a Gold Sponsor. A big company logo will be added here with a link to your website.
<a href="https://opencollective.com/coreui/contribute/gold-sponsor-40960/checkout"><img src="https://opencollective.com/coreui/tiers/gold-sponsor/0/avatar.svg?avatarHeight=100"></a>
Silver Sponsors
Support this project by becoming a Silver Sponsor. A medium company logo will be added here with a link to your website.
<a href="https://opencollective.com/coreui/contribute/silver-sponsor-40967/checkout"><img src="https://opencollective.com/coreui/tiers/gold-sponsor/0/avatar.svg?avatarHeight=100"></a>
Bronze Sponsors
Support this project by becoming a Bronze Sponsor. The company avatar will show up here with a link to your OpenCollective Profile.
<a href="https://opencollective.com/coreui/contribute/bronze-sponsor-40966/checkout"><img src="https://opencollective.com/coreui/tiers/bronze-sponsor/0/avatar.svg?avatarHeight=100"></a>
Backers
Thanks to all the backers and sponsors! Support this project by becoming a backer.
<a href="https://opencollective.com/coreui/contribute/backer-40965/checkout" target="_blank" rel="noopener"><img src="https://opencollective.com/coreui/backers.svg?width=890"></a>
<!--- EndOpenCollectiveBackers -->Copyright and license
Copyright 2024 creativeLabs Łukasz Holeczek. Code released under the MIT License. Docs released under Creative Commons.