Skip to content

Commit 02546d0

Browse files
committed
docs: Add info about features
1 parent e74781d commit 02546d0

File tree

2 files changed

+54
-1
lines changed

2 files changed

+54
-1
lines changed

README.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ CoreUI is meant to be the UX game changer. Pure & transparent code is devoid of
1919
* [Admin Templates built on top of CoreUI Pro](#admin-templates-built-on-top-of-coreui-pro)
2020
* [Installation](#installation)
2121
* [Usage](#Usage)
22+
* [Features](#Features)
2223
* [Creators](#creators)
2324
* [Community](#community)
2425
* [Community Projects](#community-projects)
@@ -250,6 +251,58 @@ $ php artisan migrate:refresh --seed
250251
# This command also rollbacks database and migrates it again.
251252
```
252253

254+
## Features
255+
256+
### Table of contents:
257+
* Notes
258+
* Users
259+
* Management of menus
260+
* Manage menu items
261+
* Role management
262+
* Management of the media
263+
* BREAD
264+
* Email Templates
265+
266+
#### Notes
267+
It is an example of data presentation in a pagination table, and CRUD functionality.
268+
269+
#### Users
270+
It is a simple example of how to manage registered users.
271+
272+
#### Menu management
273+
Menu management allows you to toggle the visibility of menu items for individual user roles.
274+
275+
#### Role management
276+
Allows you to create, edit, delete and reorder user roles.
277+
When a user has more than one role, the highest hierarchical role is used to create a menu for him.
278+
279+
#### Manage media
280+
It allows to:
281+
* Create virtual media folders.
282+
* Send media to applications.
283+
* Move media between folders,
284+
* Cut images,
285+
286+
#### BREAD system
287+
BREAD stands for: browse, read, edit, add, delete.
288+
Our BREAD system allows you to easily and quickly generate for any table, from the database, a simple BREAD.
289+
To create a new BREAD just enter a table name from the database. Then enter a name for the form. Enter the number of rows in the browse table. Choose if you want the browse table to contain buttons: "show", "edit", "add", "delete".
290+
Assign roles for users who will be able to use the ready BREAD.
291+
Then complete each column of the table separately:
292+
* the column name visible to the user,
293+
* the input type for the column,
294+
The last step is to select the appropriate checkboxes:
295+
* browse (allows to display the column in the data table),
296+
* read (allows you to display the column in the show view,)
297+
* edit (enables column editing)
298+
* add (allows you to complete the column data when adding a record. Required if the column is not nullable).
299+
It is also possible to handle relationships with another table.
300+
If the column is a foreign key, it should be specified: in the field "Optional relation table name" - table name to which the foreign key refers, in the "Optional column name in relation table - to print" field - the name of the column that is in the relation table to be displayed. Finally, select one of the two "field types" that relate to the relation: 'relation select' or 'relation radio'.
301+
302+
#### E-mail Templates
303+
It is an example of managing e-mail templates. Allows you to create, edit and delete templates. It also allows you to send an E-mail to a selected address.
304+
305+
253306
## Creators
254307

255308
**Łukasz Holeczek**

coreui/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@coreui/coreui-free-vue-laravel-admin-template",
33
"version": "3.0.0-beta.1",
4-
"description": "CoreUI Free Vue Laravel Bootstrap Admin Template Tweet",
4+
"description": "CoreUI Free Vue Laravel Bootstrap Admin Template",
55
"author": {
66
"name": "CoreUI",
77
"url": "https://coreui.io",

0 commit comments

Comments
 (0)