Skip to content

Latest commit

 

History

History
215 lines (139 loc) · 8.4 KB

README.md

File metadata and controls

215 lines (139 loc) · 8.4 KB

angular npm package npm package NPM downloads
@coreui coreui npm package npm package NPM downloads

@coreui/angular v2 library project
for use with CoreUI v2 Bootstrap Admin Template

CoreUI is an Open Source UI Kit built on top of Bootstrap 4. CoreUI is the fastest way to build modern dashboard for any platforms, browser or device. A complete Dashboard and WebApp UI Kit that allows you to quickly build eye-catching, high-quality, high-performance responsive applications using your framework of choice.

Table of Contents

Template

Prerequisites

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

Node.js

Angular 16 requires Node.js version ^16.14.0 or ^18.10.0.

  • 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@16
Update to Angular 16

see: https://update.angular.io

Installation

Several options are available:

Clone repo

$ git clone https://github.com/coreui/coreui-angular.git

NPM

$ npm install @coreui/angular --save

Yarn

$ yarn add @coreui/angular

Usage

CSS

Import scss in src/scss/style.scss

// Import styles
@import "@coreui/coreui/scss/coreui";

Or copy-paste the stylesheet <link> into your <head> before all other stylesheets to load our CSS.

<link rel="stylesheet" href="node_modules/@coreui/coreui/dist/css/coreui.min.css">

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/
├── build/
├── dist/
├── projects/
└── src/

Documentation

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

Changelog

See the GitHub release history.

Frameworks

CoreUI supports 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/.

Creators

Łukasz Holeczek

Andrzej Kopański

The CoreUI Team

Community

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

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 2024 creativeLabs Łukasz Holeczek. Code released under the MIT License. Docs released under Creative Commons.