Giter VIP home page Giter VIP logo

pawelcyrklaf / helpdesk-system Goto Github PK

View Code? Open in Web Editor NEW
2.0 1.0 0.0 290 KB

The Help Desk system is a system created in the Symfony 4 RESTful API, whose task is to support the operation of support.

License: MIT License

PHP 97.65% Twig 1.50% Dockerfile 0.59% Shell 0.26%
symfony4 fosrestbundle lexikjwtauthenticationbundle nelmioapidocbundle doctrine-orm phpunit mariadb-database nelmio-cors-bundle mariadb helpdesk

helpdesk-system's Introduction

HelpDesk System API

The Help Desk system is a system created in the Symfony 4 RESTful API, whose task is to support the operation of support. The system is to help the customer report a problem, e.g. problems with the order or the operation of services.

swagger images

Backend technology

  1. Symfony 4.4
  2. PHP 7.4 on Nginx server
  3. MariaDB 10.4
  4. Doctrine ORM
  5. RabbitMQ
  6. Elasticsearch

Composer packages used

  1. FOSRestBundle - REST API
  2. FOSElasticaBundle - Elasticsearch
  3. Lexik JWT Authentication Bundle - JWT Authentication
  4. JWT Refresh Token Bundle
  5. Nelmio Cors Bundle - CORS
  6. Symfony/test-pack - PHP Unit
  7. NelmioApiDocBundle - Swagger
  8. php-amqplib/php-amqplib - RabbitMQ
  9. KnpLabs/KnpPaginatorBundle

Environment

  1. Linux Debian 9 on local CentOS 7 on online server
  2. Apache with PHP 7.4
  3. PHPStorm
  4. MariaDB + MySQL Workbench

Installation

$ git clone https://github.com/PawelCyrklaf/helpdesk-system.git $ cd helpdesk-system
After downloading the repository, create an .env file in the application's root directory and add the following code and add your data such as data to the database, data to mail and the elasticsearch server.:

    ###> doctrine/doctrine-bundle ### 
    DATABASE_URL=mysql://DB_USER:DB_PASS@mysql:3306/DB_NAME?serverVersion=5.7 
    ###< doctrine/doctrine-bundle ###     
    
    ###> nelmio/cors-bundle ###  
    CORS_ALLOW_ORIGIN=^https?://(localhost|127\.0\.0\.1)(:[0-9]+)?$ 
    ###< nelmio/cors-bundle ###     
    
    ###> symfony/google-mailer ###  
    MAILER_DSN=gmail://GMAIL_LOGIN:GMAIL_PASS@default 
    ###< symfony/google-mailer ###     
    
    ###> friendsofsymfony/elastica-bundle ###  
    ELASTICSEARCH_URL=http://localhost:9200/ 
    ###< friendsofsymfony/elastica-bundle ###  
    
    ### <variables for docker compose> ###
    MYSQL_ROOT_PASSWORD=root_password  
    MYSQL_DATABASE=database_name  
    NGINX_PORT=80  
    LOCAL_USER=1000:1000

Add permissions to execute script:

 $ sudo chmod +x /docker/configure.sh

then execute bash script:

$ sudo /docker/configure.sh

configure.sh code:

#!/usr/bin/env bash  
docker-compose exec php php bin/console doctrine:schema:update --force  
docker-compose exec php php bin/console doctrine:fixtures:load --no-interaction  
docker-compose exec php php bin/console fos:elastica:populate

last step of installation is run docker-compose:

  $ docker-compose up -d

Default admin credential is:
username: [email protected] password: admin123

Default user credential is:
username: [email protected] password: user123

Planned features

  1. Adding support packages and integration with payment systems, eg PayPal
  2. SMS notification
  3. General chat for employees
  4. Adding attachments to tickets

API documentation

The API includes documented all available routings. After starting, just go to the address e.g. http://localhost:8000/api/doc where a detailed description of each API routing will be available.

Contact

If you have any questions, please send me email for [email protected]

helpdesk-system's People

Contributors

pawelcyrklaf avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.