PHPackages shawnsandy/pagekit - 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. [Utility & Helpers](/categories/utility) 4. / 5. shawnsandy/pagekit ActiveLibrary[Utility & Helpers](/categories/utility) shawnsandy/pagekit ================== Laravel Ui.Pages v1.0.73(9y ago)432421MITHTMLPHP ~5.6|~7.0 Since Sep 9Pushed 8y agoCompare [ Source](https://github.com/shawnsandy/ui-pages)[ Packagist](https://packagist.org/packages/shawnsandy/pagekit)[ Docs](https://github.com/shawnsandy/ui-pages)[ RSS](/packages/shawnsandy-pagekit/feed)WikiDiscussions master Synced 4w ago READMEChangelog (10)Dependencies (4)Versions (33)Used By (1) Laravel UI.Pages (PageKit) ========================== [](#laravel-uipages-pagekit) [![SensioLabsInsight](https://camo.githubusercontent.com/2ffd0b3f087e3a7caca267a044ffaaf4cd440f813dc63e0c8f6f78f50f8b309c/68747470733a2f2f696e73696768742e73656e73696f6c6162732e636f6d2f70726f6a656374732f32623135383730622d383138382d343065662d626531362d3936666561366138316262392f6d696e692e706e67)](https://insight.sensiolabs.com/projects/2b15870b-8188-40ef-be16-96fea6a81bb9) [![Codacy Badge](https://camo.githubusercontent.com/8eb07cbaff71973ff968f2e6574badfef6a91600c5e258172d029e0920916668/68747470733a2f2f6170692e636f646163792e636f6d2f70726f6a6563742f62616467652f47726164652f3331666533623830613462373465363862326430366135383539613432363135)](https://www.codacy.com/app/shawnsandy04/ui-pages?utm_source=github.com&utm_medium=referral&utm_content=shawnsandy/ui-pages&utm_campaign=Badge_Grade) 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. ### Home Page Screen Shot [](#home-page-screen-shot) [![Pages Screenshot](pagekit.png)](pagekit.png) ### Admin Dashboard (Black Haze) [](#admin-dashboard-black-haze) The dash admin will become a standalone package (deprecated) #### PageKit [](#pagekit) > If you are looking for the original PageKit package you can still find it here at [Pagekit Original](https://github.com/shawnsandy/pagekit). 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. Installation (traditional) -------------------------- [](#installation-traditional) **Laravel 5.5.\* (later)** ``` composer require shawnsandy/pagekit dev-master ``` **Laravel 5.4.\* (earlier)** ``` composer require shawnsandy/pagekit ``` **PageKitServiceProvider** Add PageKitServiceProvider to the providers array in `config/app.php` ``` ShawnSandy\PageKit\PageKitServiceProvider::class ``` **Add the following (required) vendor service providers and aliases for pre-installed Laravel packages.** Vendor Service providers `config/app/php` ``` 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 ``` '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` ``` 'markdown' => [ 'driver' => 'local', 'root' => storage_path('app/public/markdown/'), 'visibility' => 'public', ], ``` Middleware `app/Http/Kernel.php` `routeMiddlware` ``` 'shield' => \Vinkla\Shield\ShieldMiddleware::class, ``` \_\_Add to your `route/wep.php` \_\_ ``` Route::group(["prefix" => "page"], function () { Pages::routes(); }); ``` **Publish the vendor files / assets** You can publish all vendor files or simply publish the package assets (styles/js/images) **All files** ``` php artisan vendor:publish --provider="ShawnSandy\PageKit\PageKitServiceProvider" ``` **Assets** ``` php artisan vendor:publish --tag=pagekit-assets ``` **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**. ``` php artisan vendor:publish --provider="ShawnSandy\PageKit\PageKitServiceProvider" ``` or shortcut ``` php artisan vendor:publish --tag=name ``` **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 [](#install-for-custompackage-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 ----- [](#usage) Once installed correctly you should be able to goto `http://yoursite.com/page` ### Default index page [](#default-index-page) Replace the default *welcome* page with the PageKit index by modifying your `app/Http/route.php` ``` Route::get('/', function () { return view('welcome'); }); ``` *to* ``` Route::get('', function(){ return view('page::index'); }); ``` ### Enable dashboard in login [](#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](https://github.com/vinkla/laravel-shield) package that is bundled with Pages. Please insure the you have added the provider to your `config\app.php` (Vendor Providers). ``` Vinkla\Shield\ShieldServiceProvider::class, ``` Add the middleware to the $routeMiddleware array in your Kernel.php file. ``` 'shield' => \Vinkla\Shield\ShieldMiddleware::class, ``` Publish the vendor assets using the provider tag. ``` php artisan vendor:publish --provider="Vinkla\Shield\ShieldServiceProvider" ``` *Using `php artisan vendor:publish' can have some unintended affects, DON'T DO IT!!!* Run the php artisan command to generate your shield passwords `php artisan shield:hash username password` Add the password to your '/config/shield.php' file ``` 'users' => [ 'main' => ['$2y$10$wBoPEW4WJO5kTlzwkF4vw.hfGnImJV2kla4UALPNKhMLEoYUWDFL6', '$2y$10$kk9u9VdzoXAh/hL/sy6BFuUP.Prf/761rbuPMVhCBaXsYKgymS232'], ], ``` Visit [Laravel Shield](https://github.com/vinkla/laravel-shield) for more info. **Laravel .ENV editor** Required for editing editing the settings of you .env file ``` php artisan vendor:publish --provider="Brotzka\DotenvEditor\DotenvEditorServiceProvider" ``` **Components** Contact From ``` {{ Html::pageContactForm() }} ``` Page Nav ``` {{ Html::pageNav() }} ``` Page Cover ``` {{ Html::pageCover('/background/img', '500px') }} // background image, height ``` ### Custom Branding [](#custom-branding) You can custom brand pagekit by editing the values in the `config/pagekit.php` Turn branding on: ``` 'branding' => true, ``` Customize : ``` '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** ``` header-background-image' => "https://static.pexels.com/photos/129569/pexels-photo-129569-large.jpeg", ``` [!['Custom Header Background'](pagekit-custom-header.png)](pagekit-custom-header.png) TODO ---- [](#todo) ... Contributing ------------ [](#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 Change Log ---------- [](#change-log) v.1.0.1 Renamed the package and mover the repository [Pagekit Changelog](CHANGELOG.md) License ------- [](#license) TODO: Modify [licence.md](LICENCE.md) This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details ### Health Score 32 — LowBetter than 69% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity17 Limited adoption so far Community10 Small or concentrated contributor base Maturity69 Established project with proven stability Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~9 days Total 28 Last Release 3336d ago ### Community Maintainers ![](https://avatars.githubusercontent.com/u/28913?v=4)[Shawn Sandy](/maintainers/shawnsandy)[@shawnsandy](https://github.com/shawnsandy) --- Top Contributors [![shawnsandy](https://avatars.githubusercontent.com/u/28913?v=4)](https://github.com/shawnsandy "shawnsandy (175 commits)") --- Tags laravelpagekitshawnsandy ### Code Quality TestsPHPUnit Code StylePHP\_CodeSniffer ### Embed Badge ![Health badge](/badges/shawnsandy-pagekit/health.svg) ``` [![Health](https://phpackages.com/badges/shawnsandy-pagekit/health.svg)](https://phpackages.com/packages/shawnsandy-pagekit) ``` ### Alternatives [moodle/moodle Moodle - the world's open source learning platform 7.2k86.6k70](/packages/moodle-moodle)[sculpin/sculpin Static Site Generator 1.5k104.4k12](/packages/sculpin-sculpin)[pattern-lab/core The core functionality for Pattern Lab. 421.4M36](/packages/pattern-lab-core)[koriym/app-state-diagram An Application Diagram Generator 39235.8k3](/packages/koriym-app-state-diagram)[foolz/foolfuuka The FoolFuuka Imageboard 2201.8k](/packages/foolz-foolfuuka)[woutersioen/sir-trevor-php A Sir Trevor to HTML conversion helper for PHP 2834.9k](/packages/woutersioen-sir-trevor-php) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)