https://github.com/tappnetwork/filament-survey
https://github.com/tappnetwork/filament-survey
hacktoberfest
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/tappnetwork/filament-survey
- Owner: TappNetwork
- Created: 2022-09-14T21:38:51.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-08-13T18:13:55.000Z (almost 2 years ago)
- Last Synced: 2025-02-06T06:13:15.752Z (over 1 year ago)
- Topics: hacktoberfest
- Language: PHP
- Homepage:
- Size: 59.6 KB
- Stars: 27
- Watchers: 4
- Forks: 12
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Filament Laravel Survey
[](https://packagist.org/packages/tapp/filament-survey)
[](https://packagist.org/packages/tapp/filament-survey)
A Filament plugin for [Laravel Survey](https://github.com/matt-daneshvar/laravel-survey) package.
This package provides Filament resources for [Laravel Survey](https://github.com/matt-daneshvar/laravel-survey).
## Requirements
- PHP 8.1+
- Laravel 10.0+
- [Filament 3.0+](https://github.com/laravel-filament/filament)
## Dependencies
- [maatwebsite/excel](https://github.com/SpartnerNL/Laravel-Excel)
- [matt-daneshvar/laravel-survey](https://github.com/matt-daneshvar/laravel-survey)
- [spatie/eloquent-sortable](https://github.com/spatie/eloquent-sortable)
### Version Compatibility
Filament | Filament Survey
:---------|:---------------
2.x | 2.x
3.x | 3.x
4.x | 4.x
## Installation
### Installing the required package (Laravel Survey)
This plugin uses a modifed version of [Laravel Survey](https://github.com/matt-daneshvar/laravel-survey) package: https://github.com/tappnetwork/laravel-survey/tree/translatable that adds translatable and sortable fields to the survey models. More details in this PR: [matt-daneshvar/laravel-survey#39](https://github.com/matt-daneshvar/laravel-survey/pull/39).
So you must install this version instead of requiring `matt-daneshvar/laravel-survey`. In order to do so, add to your project's `composer.json`:
```php
"require": {
...
"matt-daneshvar/laravel-survey": "dev-translatable",
},
"repositories": [
...
{
"type": "vcs",
"url": "https://github.com/TappNetwork/laravel-survey"
}
],
```
Install it using Composer
```bash
composer update
```
Publish the package migrations
```bash
php artisan vendor:publish --provider="MattDaneshvar\Survey\SurveyServiceProvider" --tag="migrations"
```
Run the migrations
```bash
php artisan migrate
```
### Installing the Filament Survey plugin
### Installation
You can install the package via Composer:
#### For Filament 4
> **Note**
> For **Filament 4.x** check the **[4.x](https://github.com//TappNetwork/filament-survey/tree/4.x)** branch
#### For Filament 3
Install the plugin via Composer:
```bash
composer require tapp/filament-survey:"^3.0"
```
#### For Filament 2
> **Note**
> For **Filament 2.x** check the **[2.x](https://github.com//TappNetwork/filament-survey/tree/2.x)** branch
#### Optional: Publish the plugin's views, translations, and config
You can publish the view file with:
```bash
php artisan vendor:publish --tag="filament-survey-views"
```
You can publish the translations files with:
```bash
php artisan vendor:publish --tag="filament-survey-translations"
```
You can publish the config file with:
```bash
php artisan vendor:publish --tag="filament-survey-config"
```
### Adding the plugin to a panel
Add this plugin to a panel on `plugins()` method (e.g. in `app/Providers/Filament/AdminPanelProvider.php`).
This plugin requires the [Spatie Translatable plugin](https://filamentphp.com/plugins/filament-spatie-translatable), so it should also be added on a panel like so:
```php
use Filament\SpatieLaravelTranslatablePlugin;
use Tapp\FilamentSurvey\FilamentSurveyPlugin;
public function panel(Panel $panel): Panel
{
return $panel
// ...
->plugins([
FilamentSurveyPlugin::make(),
SpatieLaravelTranslatablePlugin::make(),
//...
]);
}
```
That's it! Now the surveys, answers, and entries resources will be displayed in the left sidebar in your Filament admin panel. To enable dedicated resources for Sections, and Questions, publish the config and add QuestionResource and SectionResource to the 'resources' array.