carlson/nova-simple-content

A simple content package for pages and blog posts for Laravel applications using Nova

Maintainers

Details

github.com/andrewicarlson/nova-simple-content

Source

Issues

Installs: 1

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

v1.0.0 2021-10-16 19:32 UTC

Requires

Requires (Dev)

MIT c8692e35203132dcfd29965af75a4c637413fe32

  • Andrew Carlson

This package is not auto-updated.

Last update: 2024-04-29 06:09:05 UTC

README

Purpose

This is a simple package for managing simple content. If all you need is to simplify the boilerplate of setting up Nova resources for things like blog posts and pages with total control over the view, this is for you. If you want complex hierarchical categorization and deep control over the post and page models then this package likely isn't a good fit.

Requirements

  1. >= Laravel 8
  2. >= Laravel Nova 3

Features

  1. Nova resource pages for Posts and Pages
  2. Independently configurable caching for Posts and Pages
  3. Event driven caching based on resource Update and Delete
  4. Unopinionated view templates – write your own!
  5. Configurable Page and Post route prefix (such as /blog, /content)
  6. 100% test coverage

Installation

  1. composer require carlson/nova-simple-content
  2. To copy the views for editing: php artisan vendor:publish --tag=nova-simple-content-views
  3. To copy the config to customize caching and routes: php artisan vendor:publish --tag=nova-simple-content-config
  4. To set up the required tables: php artisan migrate

Config

The following values may be configured in the nova-simple-content.php config file:

  1. cache_posts: Turns caching on or off for Posts. Default is true
  2. cache_pages: Turns caching on or off for Pages. Default is true
  3. post_list_url: The route for the post list. Default is '/blog'
  4. post_detail_slug_prefix: The route prefix for posts, e.g. the '/blog' in /blog/test-slug. Default is '/blog'
  5. page_slug_prefix: The route prefix for all pages, e.g. the '/content' in /content/test-slug. Default is '/content'

Caching

Caching of both Pages and Posts is turned on by default, but can be configured independently. To disable either Post or Page caching edit the corresponding value in the nova-simple-content.php config file.

Development

Contributions welcome! There is an included docker-compose.yml with containers for the correct version of PHP with required dependencies and database and cache containers for testing.

Installation

  1. Clone this repository.
  2. Ensure Docker is already installed on your machine.
  3. From the repository root run docker-compose up -d from your terminal.

Testing

All commits of PHP or JavaScript must be accompanied by corresponding tests. To run the test suite enter the running app container (docker exec -it nova_simple_content_app /bin/bash) and run composer test