Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/stephenjude/filament-blog

A faceless blog content manager with configurable richtext and markdown support for filament admin panel
https://github.com/stephenjude/filament-blog

blogging laravel publishing

Last synced: about 8 hours ago
JSON representation

A faceless blog content manager with configurable richtext and markdown support for filament admin panel

Host: GitHub
URL: https://github.com/stephenjude/filament-blog
Owner: stephenjude
License: mit
Created: 2022-02-12T19:22:31.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2024-03-25T18:42:32.000Z (9 months ago)
Last Synced: 2024-04-13T21:52:17.936Z (8 months ago)
Topics: blogging, laravel, publishing
Language: PHP
Homepage:
Size: 2.3 MB
Stars: 133
Watchers: 9
Forks: 35
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: .github/SECURITY.md

Awesome Lists containing this project

awesome-filament - stephenjude/filament-blog - A faceless blog content manager with configurable richtext and markdown support for filament admin panel. (Complete Sections)

README

        ![](https://raw.githubusercontent.com/stephenjude/filament-blog/main/art/banner.jpg)

# Filament Blog Builder

[![Latest Version on Packagist](https://img.shields.io/packagist/v/stephenjude/filament-blog.svg?style=flat-square)](https://packagist.org/packages/stephenjude/filament-blog)

[![GitHub Tests Action Status](https://img.shields.io/github/workflow/status/stephenjude/filament-blog/run-tests?label=tests)](https://github.com/stephenjude/filament-blog/actions?query=workflow%3Arun-tests+branch%3Amain)

[![GitHub Code Style Action Status](https://img.shields.io/github/workflow/status/stephenjude/filament-blog/Check%20&%20fix%20styling?label=code%20style)](https://github.com/stephenjude/filament-blog/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)

[![Total Downloads](https://img.shields.io/packagist/dt/stephenjude/filament-blog.svg?style=flat-square)](https://packagist.org/packages/stephenjude/filament-blog)

A faceless blog content manager with configurable richtext and markdown support for filament admin panel.

![](https://raw.githubusercontent.com/stephenjude/filament-blog/main/art/screen1.png)

## Filament Admin Panel

This package is tailored for [Filament Admin Panel](https://filamentphp.com/).

Make sure you have installed the admin panel before you continue with the installation. You can check the [documentation here](https://filamentphp.com/docs/admin)

## Supported Versions

PHP: `8.1` & `8.2`

Laravel: `10`

## Installation

You can install the package via composer:

```bash

composer require stephenjude/filament-blog

php artisan filament-blog:install

php artisan storage:link

php artisan migrate

```

You'll have to register the plugin in your panel provider.

```php

public function panel(Panel $panel): Panel

{

    return $panel

        ...

        ->plugin(

            Stephenjude\FilamentBlog\BlogPlugin::make()

        );

}

```

## Displaying your content

Filament blog builder is faceless, it doesn't have any opinions on how you display your content in your frontend. You can use the blog models in your controllers to display the different resources:

-   `Stephenjude\FilamentBlog\Models\Post`

-   `Stephenjude\FilamentBlog\Models\Author`

-   `Stephenjude\FilamentBlog\Models\Category`

### Posts & Drafts

```php

$posts = Post::published()->get();

$drafts = Post::draft()->get();

```

### Post Content

```php

$post = Post::find($id);

$post->id;

$post->title;

$post->slug;

$post->excerpt;

$post->banner_url;

$post->content;

$post->published_at;

```

### Post Category & Author

```php

$post = Post::with(['author', 'category'])->find($id);

$author = $post->author;

$author->id;

$author->name;

$author->email;

$author->photo;

$author->bio;

$author->github_handle;

$author->twitter_handle;

$category = $post->category;

$category->id;

$category->name;

$category->slug;

$category->description;

$category->is_visible;

$category->seo_title;

$category->seo_description;

```

### Configurations

This is the contents of the published config file:

```php

 \Filament\Forms\Components\RichEditor::class,

    /**

     * Buttons for text editor toolbar.

     */

    'toolbar_buttons' => [

        'attachFiles',

        'blockquote',

        'bold',

        'bulletList',

        'codeBlock',

        'h2',

        'h3',

        'italic',

        'link',

        'orderedList',

        'redo',

        'strike',

        'undo',

    ],

    /**

     * Configs for Posts that give you the option to change

     * the sort column and direction of the Posts.

     */

    'sort' => [

        'column' => 'published_at',

        'direction' => 'asc',

    ],

];

```

## More Screenshots

![](https://raw.githubusercontent.com/stephenjude/filament-blog/main/art/screen2.png)

---

![](https://raw.githubusercontent.com/stephenjude/filament-blog/main/art/screen3.png)

## Testing

```bash

composer test

```

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Contributing

Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.

## Security Vulnerabilities

Please review [our security policy](../../security/policy) on how to report security vulnerabilities.

## Credits

-   [stephenjude](https://github.com/stephenjude)

-   [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.