Skip to content

Commit 9ee8467

Browse files
committed
docs: update md files
1 parent e9077a9 commit 9ee8467

File tree

2 files changed

+41
-69
lines changed

2 files changed

+41
-69
lines changed

REACT.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

README.md

Lines changed: 41 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,17 @@
1515
[npm-next]: https://img.shields.io/npm/v/@coreui/react/next.png?style=flat-square
1616
[npm]: https://www.npmjs.com/package/@coreui/react
1717

18-
# CoreUI Free React Admin Template v3
18+
# CoreUI Free React Admin Template v4
1919

2020
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!
2121

2222
## Table of Contents
2323

2424
* [Versions](#versions)
2525
* [CoreUI Pro](#coreui-pro)
26+
* [Quick Start](#quick-start)
2627
* [Installation](#installation)
27-
* [Basic usage](#create-react-app)
28+
* [Basic usage](#basic-usage)
2829
* [What's included](#whats-included)
2930
* [Documentation](#documentation)
3031
* [Versioning](#versioning)
@@ -35,66 +36,53 @@ CoreUI is meant to be the UX game changer. Pure & transparent code is devoid of
3536
## Versions
3637

3738
* [CoreUI Free Bootstrap Admin Template](https://github.com/coreui/coreui-free-bootstrap-admin-template)
38-
* [CoreUI Free Angular 9+ Admin Template](https://github.com/coreui/coreui-free-angular-admin-template)
39+
* [CoreUI Free Angular Admin Template](https://github.com/coreui/coreui-free-angular-admin-template)
3940
* [CoreUI Free React.js Admin Template](https://github.com/coreui/coreui-free-react-admin-template)
4041
* [CoreUI Free Vue.js Admin Template](https://github.com/coreui/coreui-free-vue-admin-template)
41-
* [CoreUI Free Laravel Admin Template](https://github.com/coreui/coreui-free-laravel-admin-template)
42-
* [CoreUI Free Vue.js + Laravel Admin Template](https://github.com/coreui/coreui-free-vue-laravel-admin-template)
4342

4443
## CoreUI Pro
4544

4645
**Only customers with [Enterpise Membership Plan](https://coreui.io/pro/#buy) have access to private github CoreUI Pro repository.**
4746

4847
* 💪 [CoreUI Pro Bootstrap Admin Template](https://coreui.io/pro/)
49-
* 💪 [CoreUI Pro Angular 9+ Admin Template](https://coreui.io/pro/angular)
48+
* 💪 [CoreUI Pro Angular Admin Template](https://coreui.io/pro/angular)
5049
* 💪 [CoreUI Pro React Admin Template](https://coreui.io/pro/react)
5150
* 💪 [CoreUI Pro Vue Admin Template](https://coreui.io/pro/vue)
52-
* 💪 [CoreUI Pro Laravel Admin Template](https://coreui.io/pro/laravel/)
53-
* 💪 [CoreUI Pro Vue.js + Laravel Admin Template](https://coreui.io/pro/vue-laravel/)
5451

55-
## Installation
52+
## Quick Start
5653

57-
### Clone repo
54+
- [Download the latest release](https://github.com/coreui/coreui-free-react-admin-template/archive/refs/heads/v4.zip)
55+
- Clone the repo: `git clone https://github.com/coreui/coreui-free-react-admin-template.git`
5856

59-
``` bash
60-
# clone the repo
61-
$ git clone https://github.com/coreui/coreui-free-react-admin-template.git my-project
62-
63-
# go into app's directory
64-
$ cd my-project
57+
### Instalation
6558

66-
# install app's dependencies
59+
``` bash
6760
$ npm install
6861
```
6962

70-
### Copy and Paste
71-
72-
Copy all your files to your project folder and then,
63+
or
7364

7465
``` bash
75-
# go into app's directory
76-
$ cd my-project
77-
78-
# install app's dependencies
79-
$ npm install
66+
$ yarn install
8067
```
8168

82-
## Create React App
83-
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app)
84-
85-
see also:
86-
[CRA docs](https://create-react-app.dev/docs/getting-started)
87-
8869
### Basic usage
8970

9071
``` bash
9172
# dev server with hot reload at http://localhost:3000
9273
$ npm start
9374
```
9475

76+
or
77+
78+
``` bash
79+
# dev server with hot reload at http://localhost:3000
80+
$ yarn start
81+
```
82+
9583
Navigate to [http://localhost:3000](http://localhost:3000). The app will automatically reload if you change any of the source files.
9684

97-
### Build
85+
#### Build
9886

9987
Run `build` to build the project. The build artifacts will be stored in the `build/` directory.
10088

@@ -103,28 +91,34 @@ Run `build` to build the project. The build artifacts will be stored in the `bui
10391
$ npm run build
10492
```
10593

94+
or
95+
96+
```bash
97+
# build for production with minification
98+
$ yarn build
99+
```
100+
106101
## What's included
107102

108103
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:
109104

110105
```
111-
CoreUI-React#v3.0.0
112-
├── public/ #static files
113-
│ └── index.html #html template
106+
coreui-free-react-admin-template
107+
├── public/ # static files
108+
│ └── index.html # html template
114109
115-
├── src/ #project root
116-
│ ├── assets/ #assets - js icons object
117-
│ ├── containers/ #container source - template layout
118-
| │ ├── _nav.js #sidebar config
119-
| ── ...
120-
│ ├── scss/ #user scss/css source
121-
│ ├── views/ #views source
110+
├── src/ # project root
111+
│ ├── assets/ # images, icons, etc.
112+
│ ├── components/ # common components - header, footer, sidebar, etc.
113+
│ ├── layouts/ # layout containers
114+
── scss/ # scss styles
115+
│ ├── views/ # application views
116+
│ ├── _nav.js # sidebar navigation config
122117
│ ├── App.js
123-
│ ├── App.test.js
124-
│ ├── polyfill.js
118+
│ ├── ...
125119
│ ├── index.js
126-
│ ├── routes.js #routes config
127-
│ └── store.js #template state example
120+
│ ├── routes.js # routes config
121+
│ └── store.js # template state example
128122
129123
└── package.json
130124
```
@@ -133,8 +127,6 @@ CoreUI-React#v3.0.0
133127

134128
The documentation for the CoreUI Admin Template is hosted at our website [CoreUI for React](https://coreui.io/react/)
135129

136-
### :film_strip: How to setup coreui react theme in laravel. Video tutorial available [here](https://youtu.be/HVVpbpNUJ8M)
137-
138130
## Versioning
139131

140132
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/).
@@ -156,8 +148,7 @@ See [the Releases section of our project](https://github.com/coreui/coreui-free-
156148
Get updates on CoreUI's development and chat with the project maintainers and community members.
157149

158150
- Follow [@core_ui on Twitter](https://twitter.com/core_ui).
159-
- Read and subscribe to [CoreUI Blog](https://coreui.ui/blog/).
160-
151+
- Read and subscribe to [CoreUI Blog](https://blog.coreui.ui/).
161152

162153
## Copyright and License
163154

0 commit comments

Comments
 (0)