Capstone-Project

A. About this project This application was written by Jacob, Marcus, Vina, and Zach. It allows users to subscribe to classes and receive notifications based on certain events. For example, when a class has fewer than 5 seats, an email is sent to people subscribed to that class and that notification.

B. Related links The currently hosted website. This link will be broken in the near future http://40.121.205.213/

Documentation http://40.121.205.213/documentation

GitHub - where all of our code is. https://github.com/jacobforte/Capstone-Project

Google Drive - where related documents and drafts are. https://drive.google.com/drive/folders/1l0SpFqUmSPNkrlZlU97C_ytU-UZaVVmC?usp=sharing

Trello - where all of the tasks that wen into this project are. https://trello.com/b/nzKO6CA6/capstone-project

Lucid chart - where all of our carts and diagrams are located. https://www.lucidchart.com/invitations/accept/9fa4dfe6-0a7a-4ac5-a441-a2e7db21a603

Marvel app - where all of our application markups are located https://marvelapp.com/5aej573/screen/54087432

C. How to Install C.1. Required applications Apache MySQL PHP (OPTIONAL) Doxygen

C.2. Application Install

1. Copy all files to the document root. The document root location is specified in the apache configs.
2. Give Apache full permissions to all folders of the project.
3. Create a new Database through MySQL and a user that is allowed execute permissions.
4. In the MySQL command line, source all files located in the resources/SQL/TableCreateScripts folder followed by all files in the resources/SQL/StoredProcedures folder.
5. In the file resources/functions/dbconnection.function.php, edit the $dbuser, $dbpass, and $dbconnstring to the username, password, and host location/Database name you created.
6. (OPTIONAL) If you installed Doxygen, run the following command in the document root file. doxygen DoxygenConfig, this will install the documentation

C.3 Web Scrapers

1. The scrapers require a web browser driver, specifically geckodriver, to be accessible on the machine it runs on. The driver can be downloaded from here: https://github.com/mozilla/geckodriver/releases
2. Modify the application property file (ksu-scraper/src/main/resources/application.properties) to specify a MySQL database name, username, and password. Additionally, add the path to the geckdriver downloaded from step 1.
3. The scrapers are compiled to JAR files once setup has been completed. To compile, navigate to the Java main application directory (ksu-scraper/src/main/java/com/bookit) which includes the BookScraperApplication and CourseScraperApplication files. For instructions on how to compile these files to JAR files, please visit: https://www.webucator.com/how-to/how-create-jar-file-java.cfm