diff --git a/README.md b/README.md index f4d23a797..a77a0006e 100644 --- a/README.md +++ b/README.md @@ -5,23 +5,31 @@ [![@coreui coreui](https://img.shields.io/badge/@coreui%20-coreui-lightgrey.svg?style=flat-square)](https://github.com/coreui/coreui) [![npm package][npm-coreui-badge]][npm-coreui] [![NPM downloads][npm-coreui-download]][npm-coreui] -![angular](https://img.shields.io/badge/angular-^17.3.0-lightgrey.svg?style=flat-square&logo=angular) +![angular](https://img.shields.io/badge/angular-^18.0.0-lightgrey.svg?style=flat-square&logo=angular) [npm-coreui-angular]: https://www.npmjs.com/package/@coreui/angular + [npm-coreui-angular-badge]: https://img.shields.io/npm/v/@coreui/angular.png?style=flat-square + [npm-coreui-angular-badge-next]: https://img.shields.io/npm/v/@coreui/angular/next?style=flat-square&color=red + [npm-coreui-angular-download]: https://img.shields.io/npm/dm/@coreui/angular.svg?style=flat-square + [npm-coreui]: https://www.npmjs.com/package/@coreui/coreui + [npm-coreui-badge]: https://img.shields.io/npm/v/@coreui/coreui.png?style=flat-square + [npm-coreui-download]: https://img.shields.io/npm/dm/@coreui/coreui.svg?style=flat-square -# CoreUI Free Admin Dashboard Template for Angular 17 +# CoreUI Free Admin Dashboard Template for Angular 18 -CoreUI is meant to be the UX game changer. Pure & transparent code is devoid of redundant components, so the app is light enough to offer ultimate user experience. This means mobile devices also, where the navigation is just as easy and intuitive as on a desktop or laptop. The CoreUI Layout API lets you customize your project for almost any device – be it Mobile, Web or WebApp – CoreUI covers them all! +CoreUI is meant to be the UX game changer. Pure & transparent code is devoid of redundant components, so the app is light enough to offer ultimate user +experience. This means mobile devices also, where the navigation is just as easy and intuitive as on a desktop or laptop. The CoreUI Layout API lets you +customize your project for almost any device – be it Mobile, Web or WebApp – CoreUI covers them all! -- [CoreUI Angular Admin Dashboard Template & UI Components Library](https://coreui.io/angular) +- [CoreUI Angular Admin Dashboard Template & UI Components Library](https://coreui.io/angular) - [CoreUI Angular Demo](https://coreui.io/angular/demo/5.0/free/) -- [CoreUI Angular Docs](https://coreui.io/angular/docs/) +- [CoreUI Angular Docs](https://coreui.io/angular/docs/) ## Table of Contents @@ -62,23 +70,26 @@ CoreUI is meant to be the UX game changer. Pure & transparent code is devoid of |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [![CoreUI PRO Angular Admin Template](https://coreui.io/images/templates/coreui_pro_default_v3_light_dark.webp)](https://coreui.io/product/angular-dashboard-template/?theme=default-v3) | [![CoreUI PRO React Admin Template](https://coreui.io/images/templates/coreui_pro_light_v3_light_dark.webp)](https://coreui.io/product/angular-dashboard-template/?theme=light) | - ## Quick Start - [Download the latest release](https://github.com/coreui/coreui-free-angular-admin-template/) - Clone the repo: `git clone https://github.com/coreui/coreui-free-angular-admin-template.git` #### Prerequisites + Before you begin, make sure your development environment includes `Node.js®` and an `npm` package manager. ###### Node.js -[**Angular 17**](https://angular.io/guide/what-is-angular) requires `Node.js` LTS version `^18.13` or `^20.09`. + +[**Angular 18**](https://angular.io/guide/what-is-angular) requires `Node.js` LTS version `^18.19` or `^20.09`. - 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 ``` @@ -107,9 +118,11 @@ Run `build` to build the project. The build artifacts will be stored in the `dis # build for production with minification $ npm run build ``` + ## 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: +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-free-angular-admin-template @@ -136,11 +149,12 @@ The documentation for the CoreUI Admin Template is hosted at our website [CoreUI --- -This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 17.0.0. +This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 18.0.0. ## Versioning -For transparency into our release cycle and in striving to maintain backward compatibility, CoreUI Free Admin Template is maintained under [the Semantic Versioning guidelines](http://semver.org/). +For transparency into our release cycle and in striving to maintain backward compatibility, CoreUI Free Admin Template is maintained +under [the Semantic Versioning guidelines](http://semver.org/). See [the Releases section of our project](https://github.com/coreui/coreui-free-angular-admin-template/releases) for changelogs for each release version. @@ -162,7 +176,8 @@ Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github. ## Running end-to-end tests -Run `ng e2e` to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities. +Run `ng e2e` to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end +testing capabilities. ## Further help @@ -171,11 +186,13 @@ To get more help on the Angular CLI use `ng help` or go check out the [Angular C ## Creators **Łukasz Holeczek** + * * * **CoreUI team** + * https://github.com/orgs/coreui/people ## Community @@ -187,33 +204,39 @@ Get updates on CoreUI's development and chat with the project maintainers and co ## 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/). +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. +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. +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. +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. +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 @@ -225,8 +248,8 @@ Thanks to all the backers and sponsors! Support this project by [becoming a back ## Copyright and License -copyright 2024 creativeLabs Łukasz Holeczek. +copyright 2024 creativeLabs Łukasz Holeczek. - Code released under [the MIT license](https://github.com/coreui/coreui-free-react-admin-template/blob/master/LICENSE). -There is only one limitation you can't re-distribute the CoreUI as stock. You can’t do this if you modify the CoreUI. In the past, we faced some problems with persons who tried to sell CoreUI based templates. +There is only one limitation you can't re-distribute the CoreUI as stock. You can’t do this if you modify the CoreUI. In the past, we faced some problems with +persons who tried to sell CoreUI based templates.