Housemates is a web app made with the PHP Laravel framework that allows you and your roommates to share and coordinate shopping lists, chores, itineraries, contact information, and more. Visit http://housemates.fun to get started!
More detailed design information is available at: https://github.com/SCCapstone/CapstoneProject/wiki/Design
User must install Laravel and Composer.
The user must clone repository onto their local machine.
The user must also have xampp and MySQL installed in order to run an apache and MySQL database server locally.
If the user would like to create a new laravel project the commands are as follows:
User must install Laravel and Composer.
Then the user must navigate into their Laravel folder in the command line.
Next the user must type "laravel new projectName"
Developer will use command: "php artisan serve" in command line within project vscode directory to run local server for viewing webpages
For deployment the user will have to contact Camryn or another member for the necessary username and password. This will give them access to the Forge account where deployment will be possible.
The unit tests are in /tests/Unit. They are automatically integrated into Laravel with unitphp. No third-party software is necessary to unit tests. Unit tests are run using either the command 'php artisan test' or './vendor/bin/unitphp' but both achieve the same result.
The behavioral tests are in /tests/Behavioral/. They are built using the Selenium IDE. A guide for installing and using the Selenium command line runner can be found here, or, alternatively, you can use the Selenium IDE browser extension.
We do not plan on installing software to automate testing. We will create test users in testCase.php that will create users and run functions to check certain aspects of the web application.
We will run our tests through testCase.php. Compiling and running testCase.php will automatically run our application by using the file CreateApplication.php.
This project will use the PSR-12 style guide from the PHP Framework Interoperability Group.
Camryn Reid: ctreid@email.sc.edu
Colin Bowes: cbowes@email.sc.edu
Lauren Lee: lel2@email.sc.edu
Nicolas Becker: nbecker@email.sc.edu
Roscoe Burk-Moody: roscoeb@email.sc.edu