PHPackages                             haevol/laravel-openproject-feedback - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility &amp; Helpers](/categories/utility)
4. /
5. haevol/laravel-openproject-feedback

ActiveLibrary[Utility &amp; Helpers](/categories/utility)

haevol/laravel-openproject-feedback
===================================

Laravel package for collecting user feedback and automatically creating work packages in OpenProject

1.0.0(5mo ago)075MITPHPPHP ^8.1CI passing

Since Dec 9Pushed 5mo agoCompare

[ Source](https://github.com/haevol/laravel-openproject-feedback)[ Packagist](https://packagist.org/packages/haevol/laravel-openproject-feedback)[ RSS](/packages/haevol-laravel-openproject-feedback/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (1)Dependencies (5)Versions (2)Used By (0)

🚀 Laravel OpenProject Feedback
==============================

[](#-laravel-openproject-feedback)

[![Latest Version](https://camo.githubusercontent.com/0b149089a057cc54b14a986239285c7cc3f1e4ffdd4cdf37124e252fe6def98d/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f686165766f6c2f6c61726176656c2d6f70656e70726f6a6563742d666565646261636b2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/haevol/laravel-openproject-feedback)[![Total Downloads](https://camo.githubusercontent.com/ec1caec01f76d888eb4e4ed360cc5610a3c4750948517832fab8c51af04eacd2/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f686165766f6c2f6c61726176656c2d6f70656e70726f6a6563742d666565646261636b2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/haevol/laravel-openproject-feedback)[![License](https://camo.githubusercontent.com/7fa0e8087bb9de9a8fc92b4baf056d4979102d2bb5f64561e2dcee7333f86a67/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f686165766f6c2f6c61726176656c2d6f70656e70726f6a6563742d666565646261636b2e737667)](https://camo.githubusercontent.com/7fa0e8087bb9de9a8fc92b4baf056d4979102d2bb5f64561e2dcee7333f86a67/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f686165766f6c2f6c61726176656c2d6f70656e70726f6a6563742d666565646261636b2e737667)

[![PHP Version](https://camo.githubusercontent.com/ccb377a55e3b2aaf70f1d196d4ec4ba2577dca79d28c4007a0a92a61ae12fc67/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f7068702d762f686165766f6c2f6c61726176656c2d6f70656e70726f6a6563742d666565646261636b2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/haevol/laravel-openproject-feedback)[![Laravel Version](https://camo.githubusercontent.com/11ba5d99015522487fdaeafecd4de3c8f5e91bafd16811422ad0af48afd92dde/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c61726176656c2d31302e7825323025374325323031312e7825323025374325323031322e782d6f72616e67652e7376673f7374796c653d666c61742d737175617265)](https://laravel.com)

A beautiful, customizable feedback widget for Laravel applications that automatically creates work packages in OpenProject. Collect user feedback, bug reports, and feature requests directly from your application and seamlessly integrate them into your OpenProject workflow.

**Developed by [Haevol](https://haevol.org)**

---

✨ Features
----------

[](#-features)

- 🎯 **Zero Configuration** - Works out of the box with sensible defaults
- 🎨 **Fully Customizable** - Position, colors, text, and behavior are all configurable
- 📸 **Screenshot Support** - Users can attach screenshots to their feedback
- 🔗 **OpenProject Integration** - Automatically creates work packages (bugs/tasks) in OpenProject
- 🎭 **Dark Mode Support** - Beautiful dark mode styling included
- 📱 **Fully Responsive** - Works perfectly on all screen sizes
- 🔒 **Authentication Ready** - Optional authentication requirement
- ⚡ **Lightweight** - Minimal JavaScript footprint, no external dependencies
- 🎨 **Modern UI** - Clean, modern design that fits any application

---

📋 Requirements
--------------

[](#-requirements)

- PHP ^8.1
- Laravel ^10.0|^11.0|^12.0
- OpenProject instance with API access
- OpenProject API key

---

📦 Installation
--------------

[](#-installation)

Install the package via Composer:

```
composer require haevol/laravel-openproject-feedback
```

### Publish Configuration

[](#publish-configuration)

Publish the configuration file:

```
php artisan vendor:publish --tag=openproject-feedback-config
```

This will create `config/openproject-feedback.php`. Configure your OpenProject settings:

```
'openproject' => [
    'url' => env('OPENPROJECT_URL'),
    'api_key' => env('OPENPROJECT_API_KEY'),
    'project_id' => env('OPENPROJECT_PROJECT_ID'),
    'type_name' => env('OPENPROJECT_TYPE_NAME', 'Bug'),
    'status_name' => env('OPENPROJECT_STATUS_NAME', 'New'),
],
```

### Environment Variables

[](#environment-variables)

Add to your `.env` file:

```
OPENPROJECT_URL=http://your-openproject-instance.com
OPENPROJECT_API_KEY=your-api-key
OPENPROJECT_PROJECT_ID=1
OPENPROJECT_TYPE_NAME=Bug
OPENPROJECT_STATUS_NAME=New
```

### Publish Assets

[](#publish-assets)

Publish the JavaScript widget:

```
php artisan vendor:publish --tag=openproject-feedback-assets
```

This copies the widget to `resources/js/vendor/openproject-feedback/`.

### Include in Your Layout

[](#include-in-your-layout)

Add the widget component to your main layout (e.g., `resources/views/layouts/app.blade.php`):

```

```

**Note:** The widget uses `@vite()` for asset loading. Make sure your layout has a `@stack('scripts')` directive where scripts are loaded.

### Compile Assets

[](#compile-assets)

Add to your `vite.config.js`:

```
import { defineConfig } from 'vite';
import laravel from 'laravel-vite-plugin';

export default defineConfig({
    plugins: [
        laravel({
            input: [
                'resources/js/app.js',
                'resources/js/vendor/openproject-feedback/feedback-widget.js', // Add this
            ],
        }),
    ],
});
```

Then compile:

```
npm run build
```

Or for development:

```
npm run dev
```

---

🎨 Configuration
---------------

[](#-configuration)

### Widget Appearance

[](#widget-appearance)

Customize the widget in `config/openproject-feedback.php`:

```
'widget' => [
    'enabled' => true,
    'position' => 'bottom-left', // top-left, top-right, bottom-left, bottom-right
    'offset' => [
        'bottom' => 64,  // pixels from bottom
        'top' => 16,     // pixels from top
        'left' => 0,     // pixels from left
        'right' => 16,   // pixels from right
    ],
    'z_index' => 50,
    'color' => [
        'primary' => '#3b82f6',   // Tailwind blue-500
        'hover' => '#2563eb',     // Tailwind blue-600
    ],
    'text' => 'FEEDBACK',
    'show_only_authenticated' => true,
],
```

### Routes Configuration

[](#routes-configuration)

Customize the feedback submission route:

```
'routes' => [
    'enabled' => true,
    'prefix' => 'api',
    'middleware' => ['web', 'auth'],
],
```

### Form Configuration

[](#form-configuration)

Configure form fields and validation:

```
'form' => [
    'subject' => [
        'required' => true,
        'max_length' => 255,
    ],
    'description' => [
        'required' => true,
        'max_length' => 5000,
    ],
    'screenshot' => [
        'enabled' => true,
        'max_size' => 5120, // KB
    ],
],
```

---

🚀 Usage
-------

[](#-usage)

Once installed and configured, the widget will automatically appear on your pages (if `show_only_authenticated` is enabled, only for authenticated users).

### How It Works

[](#how-it-works)

1. **User clicks the feedback button** - A beautiful modal opens
2. **User fills the form** - Title, description, and optional screenshot
3. **Form submission** - Feedback is sent to your Laravel application
4. **OpenProject integration** - A work package is automatically created in OpenProject
5. **User confirmation** - User sees a success message

### Customizing the Widget

[](#customizing-the-widget)

You can customize the widget appearance by editing the published view:

```
php artisan vendor:publish --tag=openproject-feedback-views
```

This will publish the view to `resources/views/vendor/openproject-feedback/components/feedback-widget.blade.php`.

---

🔧 Advanced Usage
----------------

[](#-advanced-usage)

### Programmatic Feedback Submission

[](#programmatic-feedback-submission)

You can also submit feedback programmatically:

```
use Haevol\OpenProjectFeedback\Services\OpenProjectService;

$service = app(OpenProjectService::class);

$result = $service->createWorkPackage([
    'subject' => 'Bug Report',
    'description' => 'Detailed description...',
    'project_id' => 1,
    'type_name' => 'Bug',
    'status_name' => 'New',
    'user' => [
        'id' => auth()->id(),
        'name' => auth()->user()->name,
        'email' => auth()->user()->email,
    ],
]);
```

---

🤝 Contributing
--------------

[](#-contributing)

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request

---

📝 Changelog
-----------

[](#-changelog)

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

---

🔒 Security
----------

[](#-security)

If you discover any security-related issues, please email  instead of using the issue tracker.

---

📄 License
---------

[](#-license)

The MIT License (MIT). Please see [![License](https://camo.githubusercontent.com/7fa0e8087bb9de9a8fc92b4baf056d4979102d2bb5f64561e2dcee7333f86a67/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f686165766f6c2f6c61726176656c2d6f70656e70726f6a6563742d666565646261636b2e737667)](https://camo.githubusercontent.com/7fa0e8087bb9de9a8fc92b4baf056d4979102d2bb5f64561e2dcee7333f86a67/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f686165766f6c2f6c61726176656c2d6f70656e70726f6a6563742d666565646261636b2e737667)for more information.

---

🙏 Credits
---------

[](#-credits)

- **Developed by [Haevol](https://haevol.org)** - A software development company specializing in Laravel applications and open-source solutions.
- Built with ❤️ for the Laravel community

---

📚 Additional Resources
----------------------

[](#-additional-resources)

- [OpenProject API Documentation](https://www.openproject.org/docs/api/)
- [Laravel Documentation](https://laravel.com/docs)

---

💬 Support
---------

[](#-support)

For issues and questions, please open an issue on [GitHub](https://github.com/haevol/laravel-openproject-feedback/issues).

---

⭐ Show Your Support
-------------------

[](#-show-your-support)

If you find this package useful, please consider giving it a ⭐ on GitHub!

###  Health Score

36

—

LowBetter than 82% of packages

Maintenance73

Regular maintenance activity

Popularity13

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity43

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 89.5% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

154d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/b29190c870fea6fa08e45e118fe27e4b70853071cafb59090b541e7bdde7d041?d=identicon)[haevol](/maintainers/haevol)

---

Top Contributors

[![haevol](https://avatars.githubusercontent.com/u/248683202?v=4)](https://github.com/haevol "haevol (17 commits)")[![ilmazzi](https://avatars.githubusercontent.com/u/29540907?v=4)](https://github.com/ilmazzi "ilmazzi (2 commits)")

---

Tags

laravelfeedbackbug-trackingissue-trackingopenproject

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/haevol-laravel-openproject-feedback/health.svg)

```
[![Health](https://phpackages.com/badges/haevol-laravel-openproject-feedback/health.svg)](https://phpackages.com/packages/haevol-laravel-openproject-feedback)
```

###  Alternatives

[psalm/plugin-laravel

Psalm plugin for Laravel

3274.9M308](/packages/psalm-plugin-laravel)[watson/active

Laravel helper for recognising the current route, controller and action

3253.6M14](/packages/watson-active)[dragon-code/pretty-routes

Pretty Routes for Laravel

10058.7k4](/packages/dragon-code-pretty-routes)[glhd/conveyor-belt

14797.0k](/packages/glhd-conveyor-belt)[bjuppa/laravel-blog

Add blog functionality to your Laravel project

483.3k2](/packages/bjuppa-laravel-blog)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
