README

This Laravel Nova package allows you to create a blog, manage blogposts and posts' content. The package is geared towards headless CMS's.

Installation

Install the package in a Laravel Nova project via Composer:

composer require optimistdigital/nova-blog

Publish the nova-blog configuration file and edit it to your preference:

php artisan vendor:publish --provider="OptimistDigital\NovaBlog\ToolServiceProvider" --tag="config"

Publish the database migration(s) and run migrate:

php artisan vendor:publish --provider="OptimistDigital\NovaBlog\ToolServiceProvider" --tag="migrations"
php artisan migrate

// in app/Providers/NovaServiceProvider.php

public function tools()
{
    return [
        // ...
        new \OptimistDigital\NovaBlog\NovaBlog
    ];
}

Defining locales

The config accepts a dictionary of locales.

// in /config/nova-blog.php

// ...
'locales' => [
  'en' => 'English',
  'et' => 'Estonian',
],

// OR

'locales' => function () {
  return Locale::all()->pluck('name', 'key');
},

// if you wish to cache the configuration, pass a reference instead:

'locales' => NovaBlogConfiguration::class . '::locales',

// ...

Nova Lang

This package supports optimistdigital/nova-lang for easier content localization. After installing and setting up nova-lang package, you can use nova_lang_get_all_locales helper function in nova-blog config file

'locales' => nova_lang_get_all_locales(),

Toggling page draft feature

Draft feature allows you to create previews of resources before publishing them. By default this feature is disabled but can be enabled by installing nova-drafts package.

composer require optimistdigital/nova-drafts

Add links to front-end pages

To display a link to the actual page next to the slug, add or overwrite the closure in config/nova-blog.php for the key page_url.

// in /config/nova-blog.php

// ...
'page_url' => function (Post $post) {
  return env('FRONTEND_URL') . '/' . $post->slug;
},

// if you wish to cache the configuration, pass a reference instead:

'page_url' => NovaBlogConfiguration::class . '::pageUrl',
// ...

Helper functions

nova_get_blog_structure()

The helper function nova_get_blog_structure() returns the base posts structure (titles, slugs, published at dates, content) that you can build your routes upon in the front-end.

Example response:

[
  {
    "id": 7,
    "created_at": "2019-06-19 11:58:56",
    "updated_at": "2019-06-19 11:59:23",
    "title": "Test post 1",
    "slug": "test-post-1",
    "post_content": [
      {
        "layout": "text",
        "key": "8965c7bfc0918086",
        "attributes": {
          "text-content": "Test post content."
        }
      },
      {
        "layout": "image",
        "key": "56f5bbe608b68cd6",
        "attributes": {
          "caption": "Test post image."
        }
      }
    ],
    "published_at": "2019-06-19 09:00:00",
    "seo_title": null,
    "seo_description": null,
    "seo_image": null,
    "data": null
  },
  {
    "id": 8,
    "created_at": "2019-06-19 12:00:06",
    "updated_at": "2019-06-19 12:00:06",
    "title": "Test post 2",
    "slug": "tes-post-2",
    "post_content": [
      {
        "layout": "text",
        "key": "0e340b84bc5dec28",
        "attributes": {
          "text-content": "Test post content."
        }
      },
      {
        "layout": "image",
        "key": "a4625050e49cf77c",
        "attributes": {
          "caption": "Test post image."
        }
      }
    ],
    "published_at": "2019-06-19 09:00:05",
    "seo_title": null,
    "seo_description": null,
    "seo_image": null,
    "data": null
  }
]

nova_get_post_by_id($postId)

The helper function nova_get_post_by_id($postId) finds and returns the post with the given ID.

Example response for querying page with ID 7 (nova_get_post_by_id(7)):

{
  "id": 7,
  "name": "Test post 1",
  "slug": "testpost1",
  "published_at": "2019-06-19T09:00:00.000000Z",
  "post_content": [
    {
      "layout": "text",
      "key": "8965c7bfc0918086",
      "attributes": {
        "text-content": "Test post content."
      }
    },
    {
      "layout": "image",
      "key": "56f5bbe608b68cd6",
      "attributes": {
        "caption": "Test post image."
      }
    }
  ]
}

nova_get_post_by_slug($slug)

The helper function nova_get_post_by_slug($slug) finds and returns the post with the given slug.

Example response for querying page with slug test-post-3 (nova_get_post_by_slug('test-post-3')):

{
  "id": 14,
  "name": "Test post 3",
  "slug": "test-post-3",
  "published_at": "2019-06-25T09:00:00.000000Z",
  "post_content": [
    {
      "layout": "text",
      "key": "fc64d73f1f7508c4",
      "attributes": {
        "text-content": "Test post content."
      }
    },
    {
      "layout": "image",
      "key": "f8c9cc65b23b862a",
      "attributes": {
        "caption": "Test post image."
      }
    }
  ]
}

Credits

License

Nova blog is open-sourced software licensed under the MIT license.

optimistdigital / nova-blog

Maintainers

Details