https://github.com/omnia-digital/catalyst-reviews-plugin

https://github.com/omnia-digital/catalyst-reviews-plugin

Last synced: 2 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/omnia-digital/catalyst-reviews-plugin
• Owner: omnia-digital
• License: mit
• Created: 2023-10-04T21:31:17.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-04-29T14:35:10.000Z (about 1 year ago)
• Last Synced: 2025-04-11T04:06:36.047Z (2 months ago)
• Language: PHP
• Size: 53.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 2
• 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

README

        
# Reviews plugin for Catalyst

[![Latest Version on Packagist](https://img.shields.io/packagist/v/omnia-digital/catalyst-reviews-plugin.svg?style=flat-square)](https://packagist.org/packages/omnia-digital/catalyst-reviews-plugin)

[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/omnia-digital/catalyst-reviews-plugin/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/omnia-digital/catalyst-reviews-plugin/actions?query=workflow%3Arun-tests+branch%3Amain)

[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/omnia-digital/catalyst-reviews-plugin/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/omnia-digital/catalyst-reviews-plugin/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)

[![Total Downloads](https://img.shields.io/packagist/dt/omnia-digital/catalyst-reviews-plugin.svg?style=flat-square)](https://packagist.org/packages/omnia-digital/catalyst-reviews-plugin)

This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.

## Installation

You can install the package via composer:

```bash

composer require omnia-digital/catalyst-reviews-plugin

```

You can publish and run the migrations with:

```bash

php artisan vendor:publish --tag="catalyst-reviews-plugin-migrations"

php artisan migrate

```

You can publish the config file with:

```bash

php artisan vendor:publish --tag="catalyst-reviews-plugin-config"

```

Optionally, you can publish the views using

```bash

php artisan vendor:publish --tag="catalyst-reviews-plugin-views"

```

This is the contents of the published config file:

```php

return [

];

```

## Usage

```php

$catalystReviewsPlugin = new OmniaDigital\CatalystReviewsPlugin();

echo $catalystReviewsPlugin->echoPhrase('Hello, OmniaDigital!');

```

## 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

- [Josh Torres](https://github.com/joshtorres)

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

## License

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