databaseProject

Please add project constraints and design principles we should follow as needed.

testing the github bot

This program is run using Vagrant with the Laravel/Homestead 5.4 Virtual Box environment. Set up instructions can be found here:

##Setting up Vagrant/Homestead with our Project

1. Install Virtual Box with the default settings.

2. Install Vagrant with the default settings.

3. If you're on Windows, be sure that the "vagrnat" binary is in your System's Environment Variables.

4. Install Git Bash if you don't have it install.

5. Using Git Bash, run the command

   vagrant

   If Vagrant is properly installed, a list of possible commands should display.

6. Run the following command to install the laravel/homestead virtual box

   vagrant box add laravel/homestead

7. Create the Homestead directory in your user home directory with the following commands

   cd ~
   git clone https://github.com/laravel/homestead.git Homestead

8. Checkout a tagged version of Homestead

   cd Homestead
   git checkout v4.0.5

9. Once you've finished cloning, run the following:

   // Mac / Linux...
   bash init.sh
   

   
   // Windows...
   init.bat
   

10. This should create a Homestead.yaml file in your ~/Homestead directory.

11. Create the folder "Code" in your user's home directory.

12. Inside of the Code directory, run the following command in the Git Bash window:

    git clone https://github.com/COSC3380-Team-5/databaseProject.git cosc3380

13. You should now have the cosc3380 project source code

14. Once you have downloaded the necessary software, use a text editor to open up the ~/Homestead/homesetad.yaml file.

15. Replace the lines in the "folders:" section with the following

    map: ~/Code/cosc3380
    to: /home/vagrant/Code/cosc3380

    • This will map the ~/Code/cosc3380 in your local directory to the /home/vagrant/Code/cosc3380 in the virtual machine

16. Replace the lines in the "sites:" section with the following

    map: database.app
    to: /home/vagrant/Code/cosc3380/public

    • This will map the domain database.app to pull the files in the /home/vagrant/Code/cosc3380 directory

17. Add an entry in the "databases:" section with the following

    • cosc3380

18. Open up notepad.exe and run it as an administrator.

19. File > Open

    • Go to "C:\Windows\System32\drivers\etc" and open the "hosts" file.

20. At the very bottom enter the following: "192.168.10.10 database.app"

• This will instruct your system to direct all HTTP requests to "database.app" to "192.168.10.10" which is the IP address of your local virtual machine while it's up.

21. Using Git Bash, navigate to your Homestead directory ("cd ~/Homestead") and run the following command:

    • ssh-keygen -t rsa -C "you@homestead"
    • This will create a .ssh directory with your ssh key inside for SSh-ing into your virtual machine.

22. Using Git Bash, navigate to your home directory and run

    vagrant up

    This will spin up your virtual environment.

    • If vagrant times out at the ssh step, you may need to edit your BIOS settings and enable virtualization

23. Run the following commands.

    vagrant ssh

    • This will ssh you into the virtual machine environment

    php Code/cosc3380/app/core/database/sql/factory.php

    • This will build/populate the database with the dummy data for the app.
    • You should see a list of files that were executed being printed to the terminal window.

24. You should now be able to go to "database.app" in your web browser to view the site.

    • If you get a message saying "No input file selected" or something like that, make sure the git repository is in the correct location based on the "folders:" and "sites:" sections in the Homestead.yaml file.
    • the "sites:" section should point to cosc3380/public directory and the nginx server will automatically look for the cosc3380/public/index.php file which is the entry point of the entire app.

25. There are comments throughout the source code for navigating what is going on

Configuring Aliases

1. Using Git Bash, go to your home directory
   • cd ~
2. do

   touch .bashrc

3. In a text editor, open this file (C:\Users<username>.bashrc)
4. Add the following lines

    alias ll="ls -alh"
    alias vgserve="cd ~/Homestead; vagrant up;"

5. Close and relaunch Git Bash. You should now be able to use
   • "ll" to list all files in the current directory in a formatted manner.
   • "vgserve" to automatically navigate to your Homestead foler and spin up the virtual machine from any directory

Connecting PHPStorm with Our Database

1. Select View > Tool Windows > Database
2. A window should pop up on the right side. Click the Plus sign.
3. Select Data Source
4. Select MySQL
5. A new window should pop up.
6. Name: name it whatever you'd like that's specific to this project. cosc3380, for example.
7. Host: 192.168.10.10
8. Database: cosc3380
9. User: homestead
10. Password: secret
11. URL: leave alone
12. Driver: download if it's asking you to near the bottom
13. Click Test Connection.
14. Click Apply then Ok.

You should now be able to go to any SQL file within PHPStorm and press CTRL+Enter. You'll be prompted to select which statement you want to run.