Laravel Package providing a way to make easily complete web applications
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.travis fix (travis): Adds travis full config Dec 31, 2018
app feat(relatedlist): Adds possibility to create relations by selection Jan 16, 2019
config Scrutinizer Auto-Fixes Jan 1, 2019
database Merges master branch Jan 5, 2019
public feat(relatedlist): Adds possibility to create relations by selection Jan 16, 2019
resources feat(relatedlist): Adds possibility to create relations by selection Jan 16, 2019
routes feat(relatedlist): Adds possibility to create relations by selection Jan 16, 2019
tests/Feature/Settings Scrutinizer Auto-Fixes Jan 1, 2019
.editorconfig First commit Apr 14, 2018
.env.travis Travis configured Apr 19, 2018
.gitignore tests (menu): Checks if current module is selected in menu Dec 28, 2018
.styleci.yml First commit Apr 14, 2018
.travis.yml tests (travis): Tests only with laravel 5.7 Dec 31, 2018
CHANGELOG.md First commit Apr 14, 2018
CODE_OF_CONDUCT.md First commit Apr 14, 2018
CONTRIBUTING.md First commit Apr 14, 2018
ISSUE_TEMPLATE.md First commit Apr 14, 2018
LICENSE.md First commit Apr 14, 2018
PULL_REQUEST_TEMPLATE.md First commit Apr 14, 2018
README.md docs (readme): Improves doc Dec 28, 2018
composer.json tests (core): Configures tests Dec 31, 2018
package-lock.json fix(core): Moment library's URL for HTTPS and mono domain debug Jan 5, 2019
package.json fix(core): Moment library's URL for HTTPS and mono domain debug Jan 5, 2019
phpunit.xml tests (core): Configures tests Dec 31, 2018
scrutinizer.yml Configuration with new package name Jun 27, 2018
webpack.mix.js feat(relatedlist): Adds possibility to create relations by selection Jan 16, 2019

README.md

Uccello

Latest Version on Packagist Software License Build Status Coverage Status Quality Score Total Downloads

Uccello is a Laravel Package for providing a way to make easily complete web applications. For the moment, this package can be integrated easily only on a fresh installation.

Installation

Via Composer

$ composer require uccello/uccello:1.0.*

If you are using Laravel 5.5 or above skip this step, but if aren't then add this code on config/app.php, on providers

'providers' => [
  ...
  Lord\Laroute\LarouteServiceProvider::class,
  Uccello\Core\Providers\AppServiceProvider::class,
  Uccello\Core\Providers\RouteServiceProvider::class,
  ...
],
...
'aliases' => [
  ...
  'Uccello' => Uccello\Core\Facades\Uccello::class,
],

And then run,

$ php artisan uccello:install

This command will extract needed views for auth, and errors.

Add check permissions middleware

Open app/Http/Kernel.php file and add the following code:

protected $routeMiddleware = [
  ...
  'uccello.permissions' => \Uccello\Core\Http\Middleware\CheckPermissions::class,
  'uccello.settings' => \Uccello\Core\Http\Middleware\CheckSettingsPanel::class,
];

Migrate and seed the database

Configure .env file then run this command to migrate the database

$ php artisan migrate

Set the default routes

Add this code in routes/web.php

Route::get('/', function() {
    $domain = uccello()->useMultiDomains() ? uccello()->getLastOrDefaultDomain()->slug : null;
    $route = ucroute('uccello.home', $domain);
    return redirect($route);
});
...

If you don't want to use multi domains, add this code in .env

...
UCCELLO_MULTI_DOMAINS=false

Important : Don't forget to launch the command php artisan laroute:generate each times you change the value of UCCELLO_MULTI_DOMAINS.

Generate routes for javascript

Uccello uses laroute to port the routes over to JavaScript. It is important to launch this command every times you modify the routes.

$ php artisan laroute:generate

It will generate the file public/js/laroute.js used by Uccello.

Enjoy!

Go to your homepage. You must be redirected to the login page. You can easily sign in with the following credentials:

Login: admin
Password: admin

Testing

$ composer test

Change log

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details.

Security

If you discover any security related issues, please email jonathan@uccellolabs.com instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.