For some reason, the deployment has an issue with the vendor directory. Specifically around the Laravel Excel package. If the Download Users feature fails, delete the vendor package and run composer install again:

rm -rf vendor && composer install

You can download the latest release here. If using the command line, you can download the release using wget:

wget https://github.com/pixelated-au/CartScheduler/releases/latest/download/release.zip

Extract the release to a directory on your server. For example you cauld name the directory smpw_app or cart-scheduler.

cPanel Hosting is a little problematic because the root domain typically needs to be served from the directory ~/public_html. This means the default laravel directory structure which is served from /public. If you are serving from an addon domain, it's easier because you can setup a directory structure to suit. For example, you could setup a domain mydomain.example.com and set the directory to ~/mydomain.example.com/public.

Alternatively, you can setup a simlink to the public directory. In the example below, replace [MY ACCOUNT] with your cPanel account name:

mv public_html public_html.bak && ln -s /home/[MY ACCOUNT]/smpw_app/public /home/[MY ACCOUNT]/public_html

To deploy a release requires the following steps:

1. Download the release from the releases page
2. Extract the release to a folder on the server
3. Note: Make sure you are running PHP 8.1 or higher
4. Unzip the release.
   • If using cPanel, you can do this via the File Manager
5. Copy the .env.example file to .env and update the values as required.
   • For cPanel, you can often use sendmail as the mail server. The following settings often work in the mail section:

   • MAIL_MAILER=sendmail
     MAIL_HOST=localhost

6. SSH into the server if you haven't yet already.
7. Make sure the permissions on the installation direcotry are set to 775 and files are set to 644. Navigate to the installed directory and use this:

   find . -type d -exec chmod 775 {} \; && find . -type f -exec chmod 644 {} \;
   

8. Run the following command to enable the Laravel cache:

   php artisan key:generate \
   && php artisan config:cache \
   && php artisan route:cache \
   && php artisan view:cache \
   && php artisan event:cache \
   && php artisan storage:link

9. Or for cPanel, if the default system PHP version is not PHP 8.1, you may be able to use the following:

   ea-php82 artisan key:generate \
   && ea-php82 artisan config:cache \
   && ea-php82 artisan route:cache \
   && ea-php82 artisan view:cache \
   && ea-php82 artisan event:cache \
   && ea-php82 artisan storage:link

10. Run the following command to migrate/install the database:
    • php artisan migrate
11. Setup the cron job to run the following command every minute:
    • php artisan schedule:run >> /dev/null 2>&1
      • eg: * * * * * cd (/home/[MY_ACCOUNT]/[MY_APP] && php artisan schedule:run >> /dev/null 2>&1) <- Note, you may need to replace php with ea-php82 if you're using cPanel
12. Create the admin user. Note, this can only be run once.:
    • php artisan carts:create-user <name> <email> <phone> <gender> [<password>]
13. Navigate to the site and login with the admin user you just created.
    • If you are having a server issue (eg 500 error), review the log file at storage/logs/laravel.log.
    • If you have this issue: Your serialized closure might have been modified or it's unsafe to be unserialized, you may need to run the following command: php artisan route:clear

For development, the system uses MailHog that can be accessed at http://localhost:8025. All emails sent from the system will be available in this interface.

• If the link to /storage/example-user-import.xlsx isn't working (found on the admin, import users page), make sure the symlink has been created. Run php artisan storage:link to create the symlink.

• If admin enters a wrong email address and it generates a \Symfony\Component\Mailer\Exception\UnexpectedResponseException, send a notification to the admin
• If a user sets their availabilty to being not available but admin has assigned them a shift before the shift is released, notify the admin. If the shift is released, notify the volunteer.
• Add flag to highlight a shift hasn't opened yet
• Make locations and shifts sortable
• Add selected dates to the shifts, so rather than entering a range, admin can enter individual dates
• Facility to detect if a volunteer's 'availability' conflicts with a shift
• Facility to detect if a shift lost a volunteer after removing themselves - and causing the shift to be closed
• Test that if a shifts can't be defined at the same day/time unless there is a start and end date that doesn't overlap
• Improve the reports table
• Make publication reporting optional
• Reports:
  • Make reporting of literature optional
  • Feature to disable the reporting feature
  • Show restricted volunteers
  • Show who has outstanding reports
• Temporary volunteer
• Implement feature for admin to remove a user from a shift in addition to moving them to another shift
  • Create relationships between users so admin can assign user and their relationship to a shift
• Allow users to book another user onto a shift
• Support dark mode for toast notifications
• Test that disabled users are removed from future shifts
• Test that if a disabled shift is re-enabled, it doesn't conflict with existing shifts
• Feature to flag shifts as not self-bookable
• Content pages feature
• Day overseer feature
• User tags feature
• Notifications feature
• If a location or a shift is "re-enabled", the system should first look for schedule conflicts and show those to the admin
• Make a 'trainer' user type and allow them to un-restrict users who are with them on a shift. This feature needs to be configurable
• In admin, if 'location choices' is enabled, add location filter to the find volunteers dialog
• Add capability for admin to self-publish shifts per location. This will override automatic publishing of shifts per location