https://github.com/snowfire/snowfire-app

Laravel Package for Snowfire integration
https://github.com/snowfire/snowfire-app

Last synced: about 9 hours ago
JSON representation

Laravel Package for Snowfire integration

• Host: GitHub
• URL: https://github.com/snowfire/snowfire-app
• Owner: snowfire
• Created: 2014-09-22T14:05:49.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2015-04-11T08:50:33.000Z (over 9 years ago)
• Last Synced: 2024-08-18T18:16:26.376Z (3 months ago)
• Language: PHP
• Size: 244 KB
• Stars: 0
• Watchers: 8
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
## Snowfire App

This packages makes it possible to connect your Laravel app to Snowfire.

## Install the package

Add this to your composer.json

	"snowfire/snowfire-app": "dev-master"

Add this to your service providers in `config/app.php`

    'Snowfire\App\SnowfireServiceProvider'

Add this to your route middlewares in `app/Http/Kernel.php`

    'snowfire' => 'Snowfire\App\Middleware\SnowfireMiddleware',

    'snowfireAdmin' => 'Snowfire\App\Middleware\SnowfireAdminMiddleware',

Publish the config file

    $ php artisan vendor:publish

Create the database table for snowfire installations

    $ php artisan migrate

## Seed data

Add this to your `DatabaseSeeder.php`

    $this->call('\Snowfire\App\Storage\Seeder');

## CSRF protection

If you have CSRF middleware activated in `app/Http/Kernel.php` open `app/Http/Middleware/VerifyCsrfToken.php` and add the following to the handle method:

```php

if ($request->header('User-Agent') == 'Snowfire')

{

	return $next($request);

}

```

## Integration possibilities

There are two different ways to connect your app to Snowfire. As a link in the admin area and as a public action.

### Example

Lets say you have a list of events. A public action will be something like `http://your-app.com/events/all` which will render an HTML `
` list. Then you will have an admin link from Snowfire to `http://your-app.com/admin` which will let users add/edit/remove events.


Start by adding your actions to `config/snowfire_app.php`

```php

return [

	'id' => 'demo_app',

	'name' => 'Demo app',

	'tab' => 'admin',

	'actions' => [

		'events' => 'action.events.index',

		'event' => 'action.events.show',

	]

];

```

This config adds the admin link as a named route called `snowfire.tab` and a route for all events. Both tab and actions are optional (but you need one of them, right?)

#### Your `routes.php`

```php

// Admin routes

Route::group(['prefix' => 'admin/{snowfireAppId}', 'before' => 'snowfireAppAuth', 'namespace' => 'Admin'], function()

{

	Route::get('/', ['as' => 'admin.index', function($appId)

    {

        return 'Admin for appId: ' . $appId;

    }]);

});

// Action routes

Route::group(['namespace' => 'Action'], function()

{

	Route::get('events', ['uses' => 'EventsController@index', 'as' => 'action.events.index']);

	Route::get('events/{id}', ['uses' => 'EventsController@event', 'as' => 'action.events.show']);

});

```

This creates an admin route and the public action. The admin route is behind a snowfireAppAuth filter which makes sure the user is logged in and trusted.

### Your Snowfire snippet to the public event list

Login to Snowfire and install the app (System -> Apps)

	http://your-hosted-app.com/snowfire/install

Create a new snippet with this code:

```javascript

    All events

    

```

**Warning:** Adding applications to the root / (i.e the home page) is currently not supported. Please create a sub page to add your app.

Now just add the snippet to a page and it will show you a list of events.

## Links

When you are working in an action that will be rendered within Snowfire, you need to use:

```html

A linked route

```

This will make sure the links works from within Snowfire.