new project final

Installation

# clone the repo
$ git clone https://github.com/coreui/coreui-free-vue-laravel-admin-template.git my-project

# go into app's directory
$ cd my-project/laravel

# install app's dependencies
$ composer install

# install app's dependencies
$ npm install

If you choose SQLite

# create database
$ touch database/database.sqlite

Copy file ".env.example", and change its name to ".env". Then in file ".env" replace this database configuration:

• DB_CONNECTION=mysql
• DB_HOST=127.0.0.1
• DB_PORT=3306
• DB_DATABASE=laravel
• DB_USERNAME=root
• DB_PASSWORD=

To this:

• DB_CONNECTION=sqlite
• DB_DATABASE=/path_to_your_project/database/database.sqlite

If you choose PostgreSQL

1. Install PostgreSQL

2. Create user

$ sudo -u postgres createuser --interactive
enter name of role to add: laravel
shall the new role be a superuser (y/n) n
shall the new role be allowed to create database (y/n) n
shall the new role be allowed to create more new roles (y/n) n

3. Set user password

$ sudo -u postgres psql
postgres= ALTER USER laravel WITH ENCRYPTED PASSWORD 'password';
postgres= \q

4. Create database

$ sudo -u postgres createdb laravel

5. Copy file ".env.example", and change its name to ".env". Then in file ".env" replace this database configuration:

• DB_CONNECTION=mysql
• DB_HOST=127.0.0.1
• DB_PORT=3306
• DB_DATABASE=laravel
• DB_USERNAME=root
• DB_PASSWORD=

To this:

• DB_CONNECTION=pgsql
• DB_HOST=127.0.0.1
• DB_PORT=5432
• DB_DATABASE=laravel
• DB_USERNAME=laravel
• DB_PASSWORD=password

If you choose MySQL

Copy file ".env.example", and change its name to ".env". Then in file ".env" complete this database configuration:

• DB_CONNECTION=mysql
• DB_HOST=127.0.0.1
• DB_PORT=3306
• DB_DATABASE=laravel
• DB_USERNAME=root
• DB_PASSWORD=

Next step

# in your app directory
# generate laravel APP_KEY
$ php artisan key:generate

# generate jwt secret
$ php artisan jwt:secret

# run database migration and seed
$ php artisan migrate:refresh --seed

# go to coreui directory
$ cd ../coreui

# install app's dependencies
$ npm install

Usage

Test

# test
$ php vendor/bin/phpunit

If you need separate backend and frontend

# back to laravel directory
$ cd ../laravel

# start local server
$ php artisan serve

$ cd ../coreui

$ npm run serve

Open your browser with address: localhost:8080

If you need change backend adress go to file /coreui/src/main.js And change line:

Vue.prototype.$apiAdress = 'http://127.0.0.1:8000'

If you don't need separate backend and frontend

1. Go to file /laravel/routes/web.php And uncomment this lines:

Route::get('/{any}', function () {
    return view('coreui.homepage');
})->where('any', '.*');

2. Go to file /laravel/config/filesystems.php And change this line:

'root' => public_path() . '/../../coreui/public/public',

To this:

'root' => public_path('public'),

3. Go to file /coreui/src/views/media/Media.vue And change this line:

changePort: 'localhost:8080',

To this:

changePort: 'localhost:8000',

# back to laravel directory
$ cd ../laravel

# generate mixing
$ npm run dev

# and repeat generate mixing
$ npm run dev

# start local server
$ php artisan serve

Open your browser with address: localhost:8000

When you have project open in browser

Click "Login" on sidebar menu and log in with credentials:

• E-mail: admin@admin.com
• Password: password

This user has roles: user and admin

---

How to add a link to the sidebar:

Instructions for CoreUI Free Vue Laravel admin template only. Pro version have separate instruction.

To add a link to the sidebar - modify seeds file:

my-project/database/seeds/MenusTableSeeder.php

In run() function - add insertLink():

$id = $this->insertLink( $rolesString, $visibleName, $href, $iconString);

• $rolesString - a string with list of user roles this menu element will be available, ex. "guest,user,admin"
• $visibleName - a string caption visible in sidebar
• $href - a href, ex. /homepage or http://example.com
• $iconString - a string containing valid CoreUI Icon name (kebab-case), ex. cil-speedometer or cil-pencil

To add a title to the sidebar - use function insertTitle():

$id = $this->insertTitle( $rolesString, $title );

• $rolesString - a string with list of user roles this menu element will be available, ex. "guest,user,admin"
• $title - a string caption visible in sidebar

To add a dropdown menu to the sidebar - use function beginDropdown():

$id = $this->beginDropdown( $rolesString, $visibleName, $href, $iconString);

• $rolesString - a string with list of user roles this menu element will be available, ex. "guest,user,admin"
• $visibleName - a string caption visible in sidebar
• $href - a href, ex. /homepage or http://example.com
• $iconString - a string containing valid CoreUI icon name (kebab-case). For example: cil-speedometer or cil-pencil

To end dropdown section - use function endDropdown().

To add link to dropdown call function insertLink() between function calls beginDropdown() and endDropdown(). Example:

$id = $this->beginDropdown('guest,user,admin', 'Some dropdown', 'http://example.com', 'cil-puzzle');
$id = $this->insertLink('guest,user,admin', 'Dropdown name', 'http://example.com');
$this->endDropdown();

IMPORTANT - At the end of run() function, call joinAllByTransaction() function:

$this->joinAllByTransaction();

Once done with seeds file edit, run:

$ php artisan migrate:refresh --seed
# This command also rollbacks database and migrates it again.

Features

Table of contents:

• Notes
• Users
• Menu management
• Role management
• Management of the media
• BREAD
• Email Templates

Notes

It is an example of data presentation in a pagination table, and CRUD functionality.

Users

It is a simple example of how to manage registered users.

Menu management

Menu management allows you to toggle the visibility of menu items for individual user roles.

Role management

Allows you to create, edit, delete and reorder user roles. When a user has more than one role, the highest hierarchical role is used to create a menu for him.

Manage media

It allows to:

• Create virtual media folders.
• Send media to applications.
• Move media between folders,
• Cut images,

BREAD system

BREAD stands for: browse, read, edit, add, delete. Our BREAD system allows you to easily and quickly generate for any table, from the database, a simple BREAD. 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". Assign roles for users who will be able to use the ready BREAD. Then complete each column of the table separately:

• the column name visible to the user,
• the input type for the column, The last step is to select the appropriate checkboxes:
• browse (allows to display the column in the data table),
• read (allows you to display the column in the show view,)
• edit (enables column editing)
• add (allows you to complete the column data when adding a record. Required if the column is not nullable). It is also possible to handle relationships with another table. 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'.

E-mail Templates

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.