PHPackages                             wizclumsy/cms - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. wizclumsy/cms

ActiveLibrary[Framework](/categories/framework)

wizclumsy/cms
=============

A CMS for Laravel

0.28.8(9y ago)06MITPHP

Since Feb 16Pushed 9y agoCompare

[ Source](https://github.com/WizInteractive/wizclumsy)[ Packagist](https://packagist.org/packages/wizclumsy/cms)[ RSS](/packages/wizclumsy-cms/feed)WikiDiscussions master Synced 2mo ago

READMEChangelog (2)Dependencies (7)Versions (122)Used By (0)

Clumsy
======

[](#clumsy)

A white-label CMS for Laravel

[![Latest Stable Version](https://camo.githubusercontent.com/18fb162d6d9c257af270ba3cc329b1d8eaf50ab4c4201d75c2479281e4a9f457/68747470733a2f2f706f7365722e707567782e6f72672f636c756d73792f636d732f76657273696f6e)](https://packagist.org/packages/clumsy/cms) [![Latest Unstable Version](https://camo.githubusercontent.com/a9f42332c534711c6e264c5ae43fa8b8bf85e84336f6345e0b6d5ab45ac7ece3/68747470733a2f2f706f7365722e707567782e6f72672f636c756d73792f636d732f762f756e737461626c65)](//packagist.org/packages/clumsy/cms) [![Codacy Badge](https://camo.githubusercontent.com/46c9c10fb7f481b345c6042f5869e2dc1dbf7997c3551876e6b8450f5497ceeb/68747470733a2f2f6170692e636f646163792e636f6d2f70726f6a6563742f62616467652f47726164652f3439643839653439643238383466613762613331393963393738656132623635)](https://www.codacy.com/app/tbuteler/clumsy?utm_source=github.com&utm_medium=referral&utm_content=tbuteler/clumsy&utm_campaign=Badge_Grade) [![SensioLabsInsight](https://camo.githubusercontent.com/fae0d77e7176b6823b4739626b59cee03ac275d9399ed0b281c7c46d485a3e66/68747470733a2f2f696e73696768742e73656e73696f6c6162732e636f6d2f70726f6a656374732f32613363376232662d353938302d346563632d623635622d6235376363373437633762612f6d696e692e706e67)](https://insight.sensiolabs.com/projects/2a3c7b2f-5980-4ecc-b65b-b57cc747c7ba)

Installing
----------

[](#installing)

Use Composer to install:

```
composer require clumsy/cms

```

In the `config/app.php` file, add this to the `providers` key:

```
Wizclumsy\CMS\CMSServiceProvider::class,
```

Optionally, you can set the following aliases:

```
'Clumsy' => Wizclumsy\CMS\Facades\Clumsy::class,
'Overseer' => Wizclumsy\CMS\Facades\Overseer::class,
'Shortcode' => Wizclumsy\CMS\Facades\Shortcode::class,
```

Publish Clumsy configuration:

```
php artisan vendor:publish --provider="Wizclumsy\CMS\CMSServiceProvider" --tag=config

```

Run migrations to get the admin area's authentication tables and media management tables:

```
php artisan migrate

```

Finally, publish all Clumsy public assets:

```
php artisan clumsy:publish

```

Usage
-----

[](#usage)

Clumsy will create an admin area where its users can manage resources. Before you start adding resources and routes, it could be a good idea to make sure you have access to it. Ideally, if you have many users, you would create a seeder in which you would register them all at once. If you just want to get up and running for development, you can user the following:

```
php artisan clumsy:user

```

You will be prompted for email, name, password and optionally a user level.

With a user of your own you can proceed to the admin area. By default this will be  (you can configure this by editing the `authentication-prefix` in the config). After successful authentication, if you haven't yet defined a route which resolves the  URL, you will see a simple message that reads: `[Admin home] Clumsy is correctly set up.`

Adding routes to that authenticated admin area is easy: whatever route that uses the `clumsy` middleware will automatically be managed by Clumsy.

### Creating new resources

[](#creating-new-resources)

A resource that will be managed inside the admin area is basically an *Eloquent* model with some standard methods and properties. Most of the funcionalities which make up Clumsy are achieved by those model methods plus a standardized controller and a type of class which we call *Panels*. Because the Clumsy admin area can be customized entirely, all those classes inhabit your local app's folders and not the package's. Luckily there's an easy way to just create all those objects at once:

```
php artisan clumsy:resource post

```

The resource name (*post* in this example) defines what the classes will be called. The above command will create the following:

- `App\Post.php` model
- `App\Http\Controllers\PostsController.php` controller
- `Panels\Post\Table.php` panel
- `database\migrations\(...)_create_posts_table.php` migration
- `database\seeds\PostsSeeder.php` seeder
- some boilerplate code inside the `database\factories\ModelFactory.php` class
- `resources\views\admin\post` folder

(The above paths are based on default configuration. All object namespaces can be overridden so that the resource generator puts them in the correct place inside your local application.)

The command output will also give you the resourceful route. By now your `routes\web.php` might look like this:

```