An open API service indexing awesome lists of open source software.

https://github.com/pointblue/pb-laravel

Laravel code for Point Blue
https://github.com/pointblue/pb-laravel

Last synced: 6 months ago
JSON representation

Laravel code for Point Blue

Awesome Lists containing this project

README

          

# Point Blue Laravel

Shared Larvel code for Point Blue applications

Install with command `composer require pointblue/laravel`

In *app/Console/Kernel.php*:
- add `use PointBlue\Laravel\Views\PointBlueViews;` to the top of the page
- add `PointBlueViews::class,` to the `$commands` array

## Views

To install a view, use the command `php artisan pb:view {viewname}`
where `{viewname}` is the name of the view that will be copied to the
`resources/views` path of your laravel app. Use this list of available
views:

- `footer` - Standard Point Blue footer
- `navbar` - Standard Point Blue navigation bar
- `loading` - loading bar, requires uib-progressbar
- `docs` - Documentation View, add to routes.php (see below)
- `release` - Release Notes View, add to routes.php (see below)

- `feedback` - zendesk feedback widget - install in ``

The view will be installed to the directory
`resources/views/partials/universal`

#### Environment Variables

The views will need these environment variables to be set in the `.env` file:

- APP_URL
- PB_APP_NAME
- PB_APP_IMAGE_URL

## Routes

The following routes are assumed with code in the footer, and should be implemented in `app/Http/routes.php`:
```
Route::get('/docs', function () {
return view('pb-docs');
})->name('docs');

Route::get('/release', function () {
return view('pb-release');
})->name('release');
```

## Styles

The stylesheet `assets/sass/styles.scss` should be included in your project under `/resources/assets/sass`