shawnsandy/pagekit

Laravel Ui.Pages

Laravel UI.Pages (PageKit)

, _(*1)

Pages (ui-pages) is a simple, easy to use drop in replacement UI for the default Laravel "Welcome Page". It provides a clean and modern set of bootstrap compatible starter pages -- Home, About, Contact and a starter admin/dashboard template. Along with a static flat file system for quickly adding and using markdown files as content. Setup, configuration and customization is quick and easy, allowing you to deploy and launch a Laravel based static marketing / promotional site in minutes so you can focus on the development., _(*2)

Home Page Screen Shot

, _(*3)

Admin Dashboard (Black Haze)

The dash admin will become a standalone package (deprecated), _(*4)

PageKit

If you are looking for the original PageKit package you can still find it here at Pagekit Original. I have moved PageKit to and new repository and changed the name to avoid conflict with PageKit CMS. I also used the opportunity to reboot versioning to better meet semver standards. Sorry for the inconvenience, I hope you find the package useful., _(*5)

Installation (traditional)

Laravel 5.5.* (later), _(*6)

composer require shawnsandy/pagekit dev-master

Laravel 5.4.* (earlier), _(*7)

composer require shawnsandy/pagekit

PageKitServiceProvider, _(*8)

Add PageKitServiceProvider to the providers array in config/app.php, _(*9)

    ShawnSandy\PageKit\PageKitServiceProvider::class

Add the following (required) vendor service providers and aliases for pre-installed Laravel packages., _(*10)

Vendor Service providers config/app/php, _(*11)

``` php, <sub>(*12)</sub>

    Rap2hpoutre\LaravelLogViewer\LaravelLogViewerServiceProvider::class,
    JeroenG\Packager\PackagerServiceProvider::class,
    Sven\EnvProviders\EnvServiceProvider::class,
    Barryvdh\Debugbar\ServiceProvider::class,
    Brotzka\DotenvEditor\DotenvEditorServiceProvider::class,
    Laravel\Socialite\SocialiteServiceProvider::class,
    Vinkla\Shield\ShieldServiceProvider::class,

Vendor Aliases

```php

    'DotenvEditor' => Brotzka\DotenvEditor\DotenvEditorFacade::class,
    'Breadcrumbs' => ShawnSandy\PageKit\Facades\BreadcrumbFacade::class,
    'MD' => ShawnSandy\PageKit\Facades\MarkdownFacade::class,
    'Socialite' => Laravel\Socialite\Facades\Socialite::class,
    'Debugbar' => Barryvdh\Debugbar\Facade::class,

If you would like to use Markdown for post, add the following to config/filesystem.php, <sub>(*13)</sub>

``` php, <sub>(*14)</sub>

    'markdown' => [
        'driver' => 'local',
        'root' => storage_path('app/public/markdown/'),
        'visibility' => 'public',
    ],

 Middleware `app/Http/Kernel.php` `routeMiddlware`

```php

    'shield' => \Vinkla\Shield\ShieldMiddleware::class,

__Add to your route/wep.php __, <sub>(*15)</sub>

``` php, <sub>(*16)</sub>

Route::group(["prefix" => "page"], function () { Pages::routes(); });, <sub>(*17)</sub>

__Publish the vendor files / assets__

You can publish all vendor files or simply publish the package assets (styles/js/images)

**All files**
``` bash

php artisan vendor:publish --provider="ShawnSandy\PageKit\PageKitServiceProvider"

Assets, <sub>(*18)</sub>

``` bash php artisan vendor:publish --tag=pagekit-assets, <sub>(*19)</sub>

__Publish tags__

You can publish individual pagekit tags using `--tags` option, *please note* that the `--pagekit-asssets` tag is required for page to display correctly. **BTW this is my preferred method of install**.

``` bash

php artisan vendor:publish --provider="ShawnSandy\PageKit\PageKitServiceProvider"

or shortcut, <sub>(*20)</sub>

``` bash php artisan vendor:publish --tag=name, <sub>(*21)</sub>

**PageKit tags**

* `--tag=pagekit-assets` publishes your pagekit public assets / files to `/public/`
* `--tag=pagekit-views` publishes your views to `vendor\pagekit`
* `--tag=pagekit-config` publishes configuration file `config\pagekit` to `config`

You can also use the `--force` to overwrite previously published files - `--tag=pagekit-assets --force`.

### Install for custom/package development

To customize or use the package to start your own.

* Install [Laravel Packager](https://github.com/Jeroen-G/laravel-packager#laravel-packager) `composer require jeroen-g/laravel-packager`. Make sure to add the provider to your `config\app.php` provider array `JeroenG\Packager\PackagerServiceProvider::class,`.
* Import the repository `php artisan packager:git https://github.com/shawnsandy/pagekit YourVendorName YourPackgeName`. This will create and download the package to `/packages/YourVendorName/YourPackageName`. It will also add your package to composer autoload parameter and add it to `config/app.php` provider array.
* Customize and push to you repo
* Enjoy


## Usage

Once installed correctly you should be able to goto  `http://yoursite.com/page`

### Default index page

Replace the default *welcome* page with the PageKit index by modifying your `app/Http/route.php`

```php
Route::get('/', function () {
    return view('welcome');
});

to, <sub>(*22)</sub>

  Route::get('', function(){
        return view('page::index');
    });

Enable dashboard in login

Pages comes database free by default, as a result your admin Dash(board) won't require any login. However you can enable statless login using the Laravel Shield package that is bundled with Pages., <sub>(*23)</sub>

Please insure the you have added the provider to your config\app.php (Vendor Providers)., <sub>(*24)</sub>

Vinkla\Shield\ShieldServiceProvider::class,

Add the middleware to the $routeMiddleware array in your Kernel.php file., <sub>(*25)</sub>

'shield' => \Vinkla\Shield\ShieldMiddleware::class,

Publish the vendor assets using the provider tag., <sub>(*26)</sub>

php artisan vendor:publish --provider="Vinkla\Shield\ShieldServiceProvider"

Using `php artisan vendor:publish' can have some unintended affects, DON'T DO IT!!!, <sub>(*27)</sub>

Run the php artisan command to generate your shield passwords php artisan shield:hash username password, <sub>(*28)</sub>

Add the password to your '/config/shield.php' file, <sub>(*29)</sub>

  'users' => [
        'main' => ['$2y$10$wBoPEW4WJO5kTlzwkF4vw.hfGnImJV2kla4UALPNKhMLEoYUWDFL6',
            '$2y$10$kk9u9VdzoXAh/hL/sy6BFuUP.Prf/761rbuPMVhCBaXsYKgymS232'],
    ],

Visit Laravel Shield for more info., <sub>(*30)</sub>

Laravel .ENV editor, <sub>(*31)</sub>

Required for editing editing the settings of you .env file, <sub>(*32)</sub>

``` bash php artisan vendor:publish --provider="Brotzka\DotenvEditor\DotenvEditorServiceProvider", <sub>(*33)</sub>

__Components__

Contact From

``` php

{{ Html::pageContactForm() }}

Page Nav, <sub>(*34)</sub>

{{ Html::pageNav() }}

Page Cover, <sub>(*35)</sub>

{{ Html::pageCover('/background/img', '500px') }} // background image, height

Custom Branding

You can custom brand pagekit by editing the values in the config/pagekit.php, <sub>(*36)</sub>

Turn branding on:, <sub>(*37)</sub>

    'branding' => true,

Customize :, <sub>(*38)</sub>

'brand' => [
    'background-color' => '#FFFFFF',
    'header-background-color' => '#EEEEEE',
    'header-font-size' => '72px',
    'font-family' => '"Helvetica Neue", Helvetica, Arial, sans-serif',
    'header-font-color' => '#eee',
    'footer-background-color' => '#333333',
    'footer-color' => '#FFFFFF',
    'header-color' => '#EEEEEE',
    'text-color' => 'FFFFFF',
    'header-background-image' => "https://static.pexels.com/photos/129569/pexels-photo-129569-large.jpeg",
    'logo' => false
]

Custom Header, <sub>(*39)</sub>

header-background-image' => "https://static.pexels.com/photos/129569/pexels-photo-129569-large.jpeg",

, <sub>(*40)</sub>

TODO

..., <sub>(*41)</sub>

Contributing

Fork it! Create your feature branch: git checkout -b my-new-feature Commit your changes: git commit -am 'Add some feature' Push to the branch: git push origin my-new-feature Submit a pull request :D History, <sub>(*42)</sub>

Change Log

v.1.0.1, <sub>(*43)</sub>

Renamed the package and mover the repository, <sub>(*44)</sub>

Pagekit Changelog, <sub>(*45)</sub>

License

TODO: Modify licence.md, <sub>(*46)</sub>

This project is licensed under the MIT License - see the LICENSE.md file for details, <sub>(*47)</sub>