https://github.com/area17/twill-capsule-homepages

A Twill Capsule to create a Home page for your website
https://github.com/area17/twill-capsule-homepages

Last synced: about 2 months ago
JSON representation

A Twill Capsule to create a Home page for your website

• Host: GitHub
• URL: https://github.com/area17/twill-capsule-homepages
• Owner: area17
• License: mit
• Created: 2021-05-15T16:32:30.000Z (over 3 years ago)
• Default Branch: stable
• Last Pushed: 2022-11-29T16:42:29.000Z (about 2 years ago)
• Last Synced: 2024-08-03T17:12:36.360Z (5 months ago)
• Language: PHP
• Size: 766 KB
• Stars: 6
• Watchers: 8
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Support: Support/Crops.php

Awesome Lists containing this project

• awesome-twill - Homepages Capsule - A Twill Capsule to create a Home page for your website (Packages)

README

        
# Homepages Capsule

### A [Twill Capsule](https://github.com/area17/twill) to create a Home page for your website

![screenshot](docs/screenshot-1.png)

### Description

This Capsule aims to create a single page home page and for that it ensures you will always have one and only one homepage record on your database.

It also contains a middleware to shut down your website (like the `php artisan down` command) when unpublishing the homepage:

```php

protected $middleware = [

    ...

    \App\Twill\Capsules\Homepages\Http\Middleware\Shutdown::class,

];

```

**Please make sure your users have the proper permissions to edit/unpublish the homepage.**

## Installing

Before to use capsules, you need to get a [Laravel](https://laravel.com/docs/9.x/installation) app booted with [Twill](https://github.com/area17/twill) on it.

When it's done, you can clone the repo, copy the zip file or do it via

```shell

php artisan twill:capsule:install homepages --copy

```

Next, enable the capsule in your Twill configuration:

```php

    'capsules' => [

        'list' => [

            [

                'name' => 'Homepages',

                'enabled' => true

            ],

        ],

    ],

```

After that, create a `front.home` route to your homepage:

```php

Route::get('/', fn() => print('This is the homepage'))->name('front.home');

```

Finally, add this to `twill-navigation.php` to make your homepage link go directly to the edit page:

```php

return [

    'homepages' => [

        'title' => 'Homepage',

        'route' => 'admin.homepages.landing',

    ],

]

```

## Configuration

If you want to add fields in your homepage table go to `app/Twill/Capsules/Homepages/database/migrations` and modify the `create_homepages_table.php` file.

**Note:** If you want to add a new field to your homepage table, you will need to add it to the `fillable` property of the `App\Twill\Capsules\Homepages\Models\Homepage` model, and to the form in `app/Twill/Capsules/Homepages/resources/views/admin/form.blade.php`.

When you are ready, don't forget to run the migration:

```shell

php artisan migrate

```

After that, refresh your admin view, you should see a new entry in your navigation bar.

Go into it and manage your homepage.