xguard/phone-scheduler

A phone scheduler tool to organise employee shifts & priority. For use with twilio

v1.2.2 2023-08-11 04:45 UTC

MIT

• Siamak Samie

README

This is a phone scheduling application that generates data to be fetched by twilio.

Installation

Use the following commands to install

composer require xguard/phone-scheduler
php artisan migrate
php artisan vendor:publish --provider="Xguard\PhoneScheduler\PhoneSchedulerServiceProvider" --force

Use the following command to create an admin. It will prompt you for basic info including an ERP email.

php artisan phone-scheduler:create-admin

You can now go to the /phone-schduler path to use the pacakge. You must first login to the ERP.

To get a formatted json of the phone scheduler you can use the following API endpoint path:

/api/formatted-phone-line-data/{id}

To get current available dispatcher via a "level" you can use the following API endpoint path:

/api/get-available-agent/{id}/{level}

Develpment

Follow these steps to make modifications to the package

1: Firstly, download and drag the phone-scheduler folder inside your package folder at root level. Create a "package" folder if you don't have one.

2: Then, add line of code in the psr-4 of your root composer.json

"psr-4": {
    //...
    "Xguard\\PhoneScheduler\\": "package/phone-scheduler/src/"
},

3: Add the Phone Scheduler Service provider to the config/app.php

return [
    //...
    "providers" => [
        //...
        Xguard\PhoneScheduler\PhoneSchedulerServiceProvider::class,
    ]
];

4: Navigate to the phone-scheduler package folder in your command line and perform the following commands:

composer install
npm install
npm run dev

5: Return to the and publish the package with the following command:

php artisan vendor:publish --provider="Xguard\PhoneScheduler\PhoneSchedulerServiceProvider" --force

6: To run package migrations

php artisan migrate --path=package/phone-scheduler/src/database/migrations

License

Lets go ahead and say we make it open source? Liscensed under the MIT license