Skip to content

Commit 77694e2

Browse files
mrholekmrholek
committed
docs: update readme
1 parent 913ca1e commit 77694e2

File tree

1 file changed

+155
-34
lines changed

1 file changed

+155
-34
lines changed

‎README.md

Lines changed: 155 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,190 @@
1-
# CoreUI Angular - Free Bootstrap Admin Template [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=CoreUI%20-%20Free%20Angular%20Admin%20Template%20&url=http://coreui.io/angular/&hashtags=bootstrap,admin,template,dashboard,panel,free,angular,react,vue)
1+
# CoreUI Free Angular 2+ Admin Template [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&logo=twitter)](https://twitter.com/intent/tweet?text=CoreUI%20-%20Free%20Angular%20Admin%20Template%20&url=https://coreui.io/angular/&hashtags=bootstrap,admin,template,dashboard,panel,free,angular,react,vue)
22

3-
### Check out our Angular Admin Templates and support CoreUI Development
3+
Please help us on [Product Hunt](https://www.producthunt.com/posts/coreui-open-source-bootstrap-4-admin-template-with-angular-2-react-js-vue-js-support) and [Designer News](https://www.designernews.co/stories/81127). Thanks in advance!
44

5-
[![Bootstrap Admin Templates Bundle](https://genesisui.com/img/bundle2.png)](https://genesisui.com/bundle.html?support=1)
5+
Curious why I decided to create CoreUI? Please read this article: [Jack of all trades, master of none. Why Bootstrap Admin Templates suck.](https://medium.com/@lukaszholeczek/jack-of-all-trades-master-of-none-5ea53ef8a1f#.7eqx1bcd8)
66

7-
[Check out Angular Bootstrap Admin Templates Bundle](https://genesisui.com/bundle.html?support=1)
7+
CoreUI is an Open Source Bootstrap Admin Template. But CoreUI is not just another Admin Template. It goes way beyond hitherto admin templates thanks to transparent code and file structure. And if that's not enough, let’s just add that CoreUI consists bunch of unique features and over 1000 high quality icons.
88

9-
This is Angular 2+ version of our Bootstrap 4 admin template [CoreUI](https://github.com/mrholek/CoreUI-Free-Bootstrap-Admin-Template).
9+
CoreUI is based on Bootstrap 4 and offers 6 versions: [HTML5 AJAX](https://github.com/coreui/free-bootstrap-admin-template-ajax), [HTML5](https://github.com/coreui/free-angular-admin-template), [Angular 2+](https://github.com/coreui/free-angular-admin-template), [React.js](https://github.com/coreui/free-react-admin-template) & [Vue.js](https://github.com/coreui/free-vue-admin-template), [.NET Core 2](https://github.com/coreui/free-dotnet-admin-template).
1010

11-
Please help us on [Product Hunt](https://www.producthunt.com/posts/coreui-open-source-bootstrap-4-admin-template-with-angular-2-react-js-vue-js-support) & [Designer News](https://www.designernews.co/stories/81127). Thanks in advance!
11+
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!
12+
13+
## Table of Contents
14+
15+
* [Versions](#versions)
16+
* [CoreUI Pro](#coreui-pro)
17+
* [Installation](#installation)
18+
* [Usage](#usage)
19+
* [What's included](#whats-included)
20+
* [Documentation](#documentation)
21+
* [Contributing](#contributing)
22+
* [Versioning](#versioning)
23+
* [Creators](#creators)
24+
* [Community](#community)
25+
* [Community Projects](#community-projects)
26+
* [License](#license)
27+
* [Support CoreUI Development](#support-coreui-development)
28+
29+
## Versions
30+
31+
* [CoreUI Free Bootstrap Admin Template (Ajax)](https://github.com/coreui/free-bootstrap-admin-template-ajax)
32+
* [CoreUI Free Angular 2+ Admin Template](https://github.com/coreui/free-angular-admin-template)
33+
* [CoreUI Free .NET Core 2 Admin Template](https://github.com/coreui/free-dotnet-admin-template)
34+
* [CoreUI Free React.js Admin Template](https://github.com/coreui/free-react-admin-template)
35+
* [CoreUI Free Vue.js Admin Template](https://github.com/coreui/free-vue-admin-template)
36+
37+
## CoreUI Pro
38+
39+
* 💪 [CoreUI Pro Bootstrap Admin Template](https://coreui.io/pro/)
40+
* 💪 [CoreUI Pro Bootstrap Admin Template (Ajax)](https://coreui.io/pro/)
41+
* 💪 [CoreUI Pro Angular Admin Template](https://coreui.io/pro/angular)
42+
* 💪 [CoreUI Pro React Admin Template](https://coreui.io/pro/react)
43+
* 💪 [CoreUI Pro Vue Admin Template](https://coreui.io/pro/vue)
44+
45+
## Installation
46+
47+
``` bash
48+
# clone the repo
49+
$ git clone https://github.com/coreui/free-angular-admin-template.git my-project
50+
51+
# go into app's directory
52+
$ cd my-project
53+
54+
# install app's dependencies
55+
$ npm install
56+
```
1257

13-
Why I decided to create CoreUI? Please read this article: [Jack of all trades, master of none. Why Boostrap Admin Templates suck.](https://medium.com/@lukaszholeczek/jack-of-all-trades-master-of-none-5ea53ef8a1f#.7eqx1bcd8)
58+
## Usage
1459

15-
CoreUI is an Open Source Angular & Bootstrap Admin Template. But CoreUI is not just another Admin Template. It goes way beyond hitherto admin templates thanks to transparent code and file structure. And if that's not enough, let’s just add that CoreUI consists bunch of unique features and over 1000 high quality icons.
60+
``` bash
61+
# serve with hot reload at localhost:4200
62+
$ ng serve
63+
```
1664

17-
CoreUI is based on Bootstrap 4 and offers 6 versions: [HTML5 AJAX](https://github.com/mrholek/CoreUI-Free-Bootstrap-Admin-Template), [HTML5 Static](https://github.com/mrholek/CoreUI-Free-Bootstrap-Admin-Template), [AngularJS](https://github.com/mrholek/CoreUI-AngularJS), [Angular 2+](https://github.com/mrholek/CoreUI-Angular), [React.js](https://github.com/mrholek/CoreUI-React) & [Vue.js](https://github.com/mrholek/CoreUI-Vue).
65+
Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
1866

19-
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!
67+
You can configure the default HTTP host and port used by the development server with two command-line options :
68+
69+
```bash
70+
ng serve --host 0.0.0.0 --port 4201
71+
```
2072

21-
[![CoreUI Angular Free Bootstrap Admin Template](http://coreui.io/assets/img/coreui.png "CoreUI Angular Free Bootstrap Admin Template")](http://coreui.io)
73+
### Generating Components, Directives, Pipes and Services
2274

23-
**NOTE:** Please remember to **STAR** this project and **FOLLOW** [my Github](https://github.com/mrholek) to keep you update with this template.
75+
You can use the `ng generate` (or just `ng g`) command to generate Angular components:
2476

25-
## Demo
77+
```bash
78+
ng generate component my-new-component
79+
ng g component my-new-component # using the alias
2680

27-
A fully functional demo is available at [CoreUI](http://coreui.io/)
81+
# components support relative path generation
82+
# if in the directory src/app/feature/ and you run
83+
ng g component new-cmp
84+
# your component will be generated in src/app/feature/new-cmp
85+
# but if you were to run
86+
ng g component ./newer-cmp
87+
# your component will be generated in src/app/newer-cmp
88+
# if in the directory src/app you can also run
89+
ng g component feature/new-cmp
90+
# and your component will be generated in src/app/feature/new-cmp
91+
```
92+
You can find all possible blueprints in the table below:
93+
94+
Scaffold | Usage
95+
--- | ---
96+
[Component](https://github.com/angular/angular-cli/wiki/generate-component) | `ng g component my-new-component`
97+
[Directive](https://github.com/angular/angular-cli/wiki/generate-directive) | `ng g directive my-new-directive`
98+
[Pipe](https://github.com/angular/angular-cli/wiki/generate-pipe) | `ng g pipe my-new-pipe`
99+
[Service](https://github.com/angular/angular-cli/wiki/generate-service) | `ng g service my-new-service`
100+
[Class](https://github.com/angular/angular-cli/wiki/generate-class) | `ng g class my-new-class`
101+
[Guard](https://github.com/angular/angular-cli/wiki/generate-guard) | `ng g guard my-new-guard`
102+
[Interface](https://github.com/angular/angular-cli/wiki/generate-interface) | `ng g interface my-new-interface`
103+
[Enum](https://github.com/angular/angular-cli/wiki/generate-enum) | `ng g enum my-new-enum`
104+
[Module](https://github.com/angular/angular-cli/wiki/generate-module) | `ng g module my-module`
105+
106+
angular-cli will add reference to `components`, `directives` and `pipes` automatically in the `app.module.ts`. If you need to add this references to another custom module, follow this steps:
107+
108+
1. `ng g module new-module` to create a new module
109+
2. call `ng g component new-module/new-component`
110+
111+
This should add the new `component`, `directive` or `pipe` reference to the `new-module` you've created.
112+
113+
```bash
114+
# build for production with minification
115+
$ ng build
116+
```
28117

29118
## What's included
30119

31-
Within the download you'll find the following directories and files, You'll see something like this:
120+
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:
32121

33122
```
34-
CoreUI-Angular/
35-
├── Angular4_CLI_Full_Project/
36-
├── Angular4_CLI_Starter/
37-
123+
free-bootstrap-admin-template/
124+
├── e2e/
125+
├── src/
126+
│ ├── app/
127+
│ ├── assets/
128+
│ ├── scss/
129+
│ ├── vendors/
130+
│ ├── ...
131+
│ ├── index.html
132+
│ └── ...
133+
├── .angular-cli.json
134+
├── package.json
135+
├── ...
136+
├── tsconfig.json
137+
└── ...
38138
```
39139

40-
## Other Versions
140+
## Documentation
41141

42-
CoreUI includes 6 Version for Angular 4, AngularJS, React.js, Vue.js, Static HTML5 and AJAX HTML5.
142+
The documentation for the CoreUI Admin Template is hosted at our website [CoreUI for Angular](https://coreui.io/angular/)
43143

44-
* [Angular Version (Angular 2+)](https://github.com/mrholek/CoreUI-Angular).
45-
* [AngularJS Version](https://github.com/mrholek/CoreUI-AngularJS).
46-
* [HTML5 AJAX Version](https://github.com/mrholek/CoreUI-Free-Bootstrap-Admin-Template).
47-
* [HTML5 Static Version](https://github.com/mrholek/CoreUI-Free-Bootstrap-Admin-Template).
48-
* [React.js Version](https://github.com/mrholek/CoreUI-React).
49-
* [Vue.js Version](https://github.com/mrholek/CoreUI-Vue).
144+
## Contributing
50145

51-
## Bugs and feature requests
146+
Please read through our [contributing guidelines](https://github.com/coreui/free-angular-admin-template/blob/master/CONTRIBUTING.md). Included are directions for opening issues, coding standards, and notes on development.
52147

53-
Have a bug or a feature request? [Please open a new issue](https://github.com/mrholek/CoreUI-Angular/issues/new).
148+
Editor preferences are available in the [editor config](https://github.com/coreui/free-angular-admin-template/blob/master/.editorconfig) for easy use in common text editors. Read more and download plugins at <http://editorconfig.org>.
54149

55-
## Documentation
150+
## Versioning
151+
152+
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/).
153+
154+
See [the Releases section of our project](https://github.com/coreui/free-angular-admin-template/releases) for changelogs for each release version.
155+
156+
## Creators
157+
158+
**Łukasz Holeczek**
159+
160+
* <https://twitter.com/lukaszholeczek>
161+
* <https://github.com/mrholek>
162+
163+
**Andrzej Kopański**
164+
165+
* <https://github.com/xidedix>
166+
167+
## Community
168+
169+
Get updates on CoreUI's development and chat with the project maintainers and community members.
170+
171+
- Follow [@coreuikit on Twitter](https://twitter.com/coreuikit).
172+
- Read and subscribe to [CoreUI Blog](https://coreui.ui/blog/).
173+
174+
### Community Projects
56175

57-
CoreUI's documentation is hosted at our website [CoreUI](http://coreui.io/)
176+
Some of projects created by community but not maintained by CoreUI team.
58177

178+
* [NuxtJS + Vue CoreUI](https://github.com/muhibbudins/nuxt-coreui)
179+
* [Colmena](https://github.com/colmena/colmena)
59180

60181
## Copyright and license
61182

62-
copyright 2017 creativeLabs Łukasz Holeczek. Code released under [the MIT license](https://github.com/mrholek/CoreUI-Angular/blob/master/LICENSE).
63-
creativeLabs Łukasz Holeczek reserves the right to change the license of future releases. You can’t re-distribute the CoreUI as stock. You can’t do this if you modify the CoreUI.
183+
copyright 2018 creativeLabs Łukasz Holeczek. Code released under [the MIT license](https://github.com/coreui/free-angular-admin-template/blob/master/LICENSE).
184+
There is only one limitation you can't can’t re-distribute the CoreUI as stock. You can’t do this if you modify the CoreUI. In past we faced some problems with persons who tried to sell CoreUI based templates.
64185

65186
## Support CoreUI Development
66187

67-
CoreUI is an MIT licensed open source project and 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 donating on [PayPal](https://www.paypal.me/holeczek) or buying one of our [premium bootstrap 4 admin templates](https://genesisui.com/?support=1).
188+
CoreUI is an MIT licensed open source project and 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 donating on [PayPal](https://www.paypal.me/holeczek), buying [CoreUI Pro Version](https://coreui.io/pro) or buying one of our [premium admin templates](https://genesisui.com/?support=1).
68189

69190
As of now I am exploring the possibility of working on CoreUI fulltime - if you are a business that is building core products using CoreUI, I am also open to conversations regarding custom sponsorship / consulting arrangements. Get in touch on [Twitter](https://twitter.com/lukaszholeczek).

0 commit comments

Comments
 (0)