rayenbou/ticket-bundle

A Symfony bundle to manage tickets

1.0 2024-06-29 21:20 UTC

MIT

• Rayen Boumaza

README

This project provides a Symfony integration for a ticketing system, allowing for the fetching of individual tickets and lists of tickets from a specified API. It utilizes the Symfony HttpClient component to communicate with the API and handles authentication through bearer tokens with JWT Token.

This project exist to be use with Dashboard Bundle.

The DashboardBundle part can be installed on your app, while the TicketBundle part can be installed on any other app.

This documentation provides a step-by-step guide to setting up the ticket environment for your project.

Right now the project is in Alpha and currently don't have any recipe but it might change soon.

How to use it

1. Register TICKET_URL,TICKET_USERNAME and TICKET_PASSWORD in your .Env (create username and password with the Dashboard Bundle).
2. Go to /ticket/.
3. Send ticket, answer through a messenger-like conversation.
4. If ticket is closed you can no longer answer to it.

Initial Setup

1. Composer

   composer require rayenbou/dashboard-bundle

Caution

If Symfony/flex is enable on your project, an error might occur at the cache:clear saying "authentication key is missing". Don't worry about this, you just have to follow Parameter setting.

1. Parameter Settings

   in config/packages/rayenbou_ticket.yaml:

   rayenbou_ticket:
        authentication:
            url: '%env(TICKET_URL)%'
            username: '%env(TICKET_USERNAME)%'
            password: '%env(TICKET_PASSWORD)%'
        settings:
            verify_peer: false

   in config/routes/rayenbou_ticket.yaml:

   rayenbou_ticket:
       resource: "@RayenbouTicketBundle/Resources/config/routing.yaml"

   in .env :

   TICKET_URL=
   TICKET_USERNAME=
   TICKET_PASSWORD=

Dev Environnement

The key verify_peer under setting in the config/packages/rayenbou_ticket.yaml is default to false to work on a self validated TLS environnement, feel free to deactivate it if you work on other environnement.

Tests

Unit tests and Integration tests are on their way.

Evolution

1. Possibility to override all templates and Controller.

Contributing

Contributions to this project are welcome. Please ensure to follow the existing coding style and add unit tests for any new or changed functionality.

Please use PHPstan and PHP-CS-FIXER.

License

This project is licensed under the MIT License - see the LICENSE file for details.