/vhs

Repository for the vhs project

Primary LanguagePHPGNU General Public License v3.0GPL-3.0

Housing Services Victoria Project

Travis License: GPL v3

Built With

Laravel 5.4

Requirements

To run your own version of this web application, install it on a LAMP or LEMP (Linux, nginx, MySQL and PHP) stack. Familiarity with Laravel 5.4+ is required.

The recommended technical stack is:

API Credentials

You will need to provide your API credentials for Twilio and Mailgun in the .env file.

To Generate Data

In order to seed the database with some initial data, you will need to run these two commands:-

composer dump-autoload
php artisan db:seed

This command will

  • create a list of all Victorian postcodes and suburbs
  • create a list of correspondence templates
  • create a list of some sample services
    (at this point the services are fictional)
  • assign the services to existing users

Now if you do not have any users in the system yet, you may need to re-run the last step after you have entered or generated some users. The command to do that would be:-

php artisan db:seed --class=UserServicesTableSeeder

To generate new users, go to the following URL
https://<your instance>/database.
This will generate up to 10 users with user addresses (with random postcodes and related suburbs.)
You may change the amount of user to be generated in App/Http/Controllers/GenerateController.php.

The first user generated will be an administrator with the login credentials:-

  • E-mail : test@test.com.au
  • Password: TestPassword
- It is IMPORTANT to immediately change the admin user login details!

Notes on Notifications

To Receive Notification

To receive sample SMS and email notification go to the following URL
https://<your instance>/notification.
The notification will be sent to the logged-in user.

Email Notifications

Laravel has a built-in notifiable trait ( for an explanation of PHP traits see http://php.net/manual/en/language.oop5.traits.php) which was used for email notification. For further reference see https://laravel.com/docs/5.5/notifications.

Twilio API Integration

For Twilio API, we have installed Aloha/Twilio package through Composer. For further reference see https://github.com/aloha/laravel-twilio.

Team

  • Tatiana Lenz
  • Teresa Villanueva
  • Rachelle Salvadora

Acknowledgement

A number of FOSS (Free and Open Source) libraries have been used.