Skip to content

Commit a8b6887

Browse files
authored
Merge pull request #2 from coreui/master
update from coreui
2 parents 8c3ca5b + eb1df6b commit a8b6887

File tree

1 file changed

+70
-0
lines changed

1 file changed

+70
-0
lines changed

README.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -245,6 +245,76 @@ $ php artisan migrate:refresh --seed
245245
# This command also rollbacks database and migrates it again.
246246
```
247247

248+
## Features
249+
250+
### Table of contents:
251+
* Notes
252+
* Users
253+
* Management of menus
254+
* Manage menu items
255+
* Role management
256+
* Management of the media
257+
* BREAD
258+
* Email Templates
259+
260+
#### Notes
261+
It is an example of data presentation in a pagination table, and CRUD functionality.
262+
263+
#### Users
264+
It is a simple example of how to manage registered users.
265+
266+
#### Menu management
267+
It is a system that allows you to create a new menu and edit existing menus. To place a new menu named "new" in any view use this code:
268+
```php
269+
<?php
270+
use the App\MenuBuilder\FreelyPositionedMenus;
271+
if(isset($appMenus['new'])){
272+
FreelyPositionedMenus::render( $appMenus['new'] , '', 'your-css-class-of-ul-element');
273+
}
274+
?>
275+
```
276+
#### Manage menu items
277+
Allows you to add, edit and delete menu items.
278+
To add a new menu item to the menu you must:
279+
* specify to which menu you are adding the item,
280+
* specify the roles of users for whom the item will be visible
281+
* name the item
282+
* type ( to choice: link, title and dropdown)
283+
* Href, the address to which the item is to refer,
284+
* Parent (To nest the item inside dropdown)
285+
* CORUI icons
286+
287+
#### Role management
288+
Allows you to create, edit, delete and reorder user roles.
289+
When a user has more than one role, the highest hierarchical role is used to create a menu for him.
290+
291+
#### Manage media
292+
It allows to:
293+
* Create virtual media folders.
294+
* Send media to applications.
295+
* Move media between folders,
296+
* Cut images,
297+
298+
#### BREAD system
299+
BREAD stands for: browse, read, edit, add, delete.
300+
Our BREAD system allows you to easily and quickly generate for any table, from the database, a simple BREAD.
301+
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".
302+
Assign roles for users who will be able to use the ready BREAD.
303+
Then complete each column of the table separately:
304+
* the column name visible to the user,
305+
* the input type for the column,
306+
The last step is to select the appropriate checkboxes:
307+
* browse (allows to display the column in the data table),
308+
* read (allows you to display the column in the show view,)
309+
* edit (enables column editing)
310+
* add (allows you to complete the column data when adding a record. Required if the column is not nullable).
311+
It is also possible to handle relationships with another table.
312+
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'.
313+
314+
#### E-mail Templates
315+
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.
316+
317+
248318
## Creators
249319

250320
**Łukasz Holeczek**

0 commit comments

Comments
 (0)