doc/ - Folder housing all documentation for the course
doc/SE_Group2_Report1.pdf - Report 1
doc/SE_Group2_Report2.pdf - Report 2
doc/SE_Group2_Report3.pdf - Report 3
doc/Demo1Presentation.ptt - Powerpoint from Demo 1
doc/Demo2Presentation.ptt - Powerpoint from Demo 2

diagrams - Folder containing diagrams. Note that most diagrams are included in the PDF reports and were not repeated in this directory.
diagrams/High Level Diagram.vsd - Contains all the Program Flow Diagrams
diagrams/stockhopUMLfrontend.png - Contains the UML diagram for the frontend
diagrams/Class Diagram Backend Drawing.vsd - Contains the UML diagram for the backend

code/  - Folder housing all source code

================================ BACKEND =====================================
code/Backend - Folder housing all of the server-side java files running on the server

code/Backend/javaSourceCode/broker.java - Main class file of "Broker Bob" program which handles the backend stock order processing and execution on thestockhop.com

code/Backend/javaSourceCode/CSVParser.java - Class that gets information from Yahoo Finance in CSV format and parses the CSV format into an array. This array is used by other classes to execute orders.

code/Backend/javaSourceCode/Database.java - Provides I/O interaction for "Broker Bob" with MySQL database

code/Backend/javaSourceCode/Mail.java - Class responsible for sending email to a user upon order execution

code/Backend/javaSourceCode/Order. java -  Constructor of "Order" data structure for use by Database.java and broker.java

code/Backend/javaSourceCode/SMS.java - Class responsible for sending SMS text messages to a user upon order execution

code/Backend/javaClasses/broker.class - Compiled broker.java class
code/Backend/javaClasses/CSVParser.class - Compiled CSVParser.java class
code/Backend/javaClasses/Database.class - Compiled Database.java class
code/Backend/javaClasses/Mail.class - Compiled Mail.java class
code/Backend/javaClasses/Order.class - Compiled Order.java class
code/Backend/javaClasses/SMS.class - Compiled SMS.java class
=========================== END BACKEND =====================================

=========================== DATABASE    ====================================

code/Database - Folder containing files related to the MySQL Database
code/Database/thestockhop.sql - .SQL file dump of the entire existing database with sample data of 'test' user
=========================== END DATABASE =====================================

================================ FRONTEND =====================================
code/Frontend - Folder housing all of the client-side and web programming files (including Symfony2 files)
code/Frontend/Install_Front_End.txt - Text file describing step-by-step instructions on installing Symfony 2 on a server and working with our Symfony2 bundle

code/Frontend/frontendSourceCode/ - Folder containing all of the Symfony2 code
code/Frontend/frontendSourceCode/app/ - The application configuration
code/Frontend/frontendSourceCode/web/ - The web root directory
code/Frontend/frontendSourceCode/src/ - The project's PHP code
code/Frontend/frontendSourceCode/src/RU/ - Arbitrary name of project (RU for Rutgers University), following Symfony2 directory structure
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle - Name of our specific Symfony2 bundle (bulk of source code goes here)

code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Tests - Folder containing PHPUnit tests
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Tests/Controller/PortfolioControllerTest.php  - Unit test of portfolio page.
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Tests/Controller/TradeControllerTest.php  - Unit test of trade page.
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Tests/Controller/OrderControllerTest.php  - Unit test of order page.
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Tests/Controller/RankingControllerTest.php  - Unit test of ranking page.
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Tests/Controller/SecurityControllerTest.php  - Unit test of login page.


code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Resources/views - Folder containing all of the HTML/Twig templates
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Resources/views/Orders/index.html.twig  - Presentation logic of orders page.
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Resources/views/Help/index.html.twig  - Presentation logic of help page.
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Resources/views/Default/Security/login.html.twig - Presentation logic of login page.
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Resources/views/Default/index.html.twig  - Presentation logic of database testing page. This is unused, was mostly for testing.
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Resources/views/Registration/form-fail-pw.html.twig - Presentation logic of 'failed signup due to password' page.
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Resources/views/Registration/form.html.twig  - Presentation logic of signup page.
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Resources/views/Registration/form-fail.html.twig  - Presentation logic of failed signup page.
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Resources/views/Prefs/index.html.twig - Presentation logic of preferences page.
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Resources/views/Advertiser/ad.html.twig - Presentation logic of advertiser page.
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Resources/views/Advertiser/mail.html.twig  - Presentation logic of email sent by the advertising form.
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Resources/views/msg.html.twig - Presentation logic for showing info messages to the user. Used on many pages, more of a generic service.
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Resources/views/Security/login-success.html.twig - Presentation logic of successful logins page.
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Resources/views/Security/login.html.twig - Presentation logic of login page.
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Resources/views/main.html.twig -  Primary site template, base of all pages presentation.
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Resources/views/Ranking/index.html.twig - Presentation logic of ranking page.
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Resources/views/Research/index-raw.html.twig - Presentation logic of research info on the trade page.
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Resources/views/Research/index.html.twig - Presentation logic of research page.
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Resources/views/Home/home_unauth.html.twig - Presentation logic of home for not logged in users page.
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Resources/views/Home/home_auth.html.twig  - Presentation logic of home for logged in users page.
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Resources/views/layout.html.twig  - Primary site template, base of all pages presentation. (Old Version).
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Resources/views/Portfolio/index.html.twig - Presentation logic of portfolio page.
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Resources/views/Trade/trade2.html.twig - Presentation logic of trade page.
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Resources/views/Trade/trade.html.twig - Presentation logic of trade page(original).

code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Resources/config - Folder containing all of the configuration files (using default XML)
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Resources/config/routing.yml - internal routing config of web requests to controllers.
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Resources/config/security.yml - configures the application to use the database as authentication.
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Resources/config/validation.yml - configures validation for web forms.

code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Entity - Contains the mappings for the ORM objects (Database Abstraction)
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Entity/Portfolio.php - Represents the portfolio table in the database as an object.
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Entity/Role.php - Represents the role table in the database as an object.
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Entity/Order.php - Represents the orders table in the database as an object.
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Entity/StockCache.php - Represents the stock_cache table in the database as an object.
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Entity/Rank.php - Represents the rank table in the database as an object.
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Entity/Account.php - Represents the account table in the database as an object.
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Entity/History.php - Represents the history table in the database as an object.

code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Controller - Application logic 
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Controller/AdvertiseController.php - Application logic for advertisers.
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Controller/PrefsController.php - Application logic for prefs page.
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Controller/ResearchController.php - Application logic for research page.
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Controller/HelpController.php - Application logic for help page, there was nothing really, this is a static page.
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Controller/PortfolioController.php - Application logic for portfolio page.
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Controller/DefaultController.php - Unused: test application logic to check databse schema.
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Controller/SecurityController.php - Application logic for logging in.
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Controller/OrdersController.php - Applciation logic for Order page.
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Controller/HomeController.php - application logic for home page.
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Controller/RankingController.php - Application logic for ranking page.
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Controller/AdminController.php - Application Logic for admin.
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Controller/SignupController.php - Application logic for signup page
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Controller/TradeController.php - Application logic for trade page.

code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Form - Folder containing all of the form definitions
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Form/Validation/SymbolValidator.php - Used by forms, check the validity of a stock symbol by using the services from the stockfacts class.
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Form/Type/ResearchType.php - a special type for the symbol field on the research form.
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Form/Type/OrderActionType.php - Unused, should have made the trade form into a seperate class, we put it in the controlller instead.

code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Repository/RankRepository.php - Helps pull rank information sorted in different ways and selected by special criteria.

code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/StockFacts.php - Contacts Yahoo! for stock information.

code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Command/RankCommand.php - Re calculates the ranks.
code/Frontend/frontendSourceCode/src/RU/TheStockHopBundle/Command/EndOfDayCommand.php - CLI command that runs via cron to purger orders with end of day experation. 

code/Frontend/frontendSourceCode/web/css - Folder containing stylesheets and images for the Symfony2 project
Note: Did not put my name in the CSS Files, because I was having a weird issue with comments in the CSS.
All CSS written by Melissa Romanus
code/Frontend/frontendSourceCode/web/css/main.css - Main css file for the project
code/Frontend/frontendSourceCode/web/css/table.css - Css for the tables on the Portfolio and Orders pages
code/Frontend/frontendSourceCode/web/css/ticker-style.css - CSS for the ticker that displays CNN RSS Feed
code/Frontend/frontendSourceCode/web/css/unauth.css - CSS for home_unauth.html.twig
code/Frontend/frontendSourceCode/web/css/form.css - CSS for all forms on the website
code/Frontend/frontendSourceCode/web/css/msg.css - CSS for Information Boxes (Order Submitted or Order Failed)
code/Frontend/frontendSourceCode/web/css/tradeScreen.css - CSS for the Trade Screen
code/Frontend/frontendSourceCode/web/css/pages/home.css - CSS for the home_auth.html.twig screen
code/Frontend/frontendSourceCode/web/css/pages/help.css - CSS for the help screen
code/Frontend/frontendSourceCode/web/css/images - Folder containing images for TheStockHop.com. Self-explanatory. All images in this folder are images used on the site.

code/Frontend/frontendSourceCode/cronjobs - Folder containing the crontab files that run the various after hours processing
code/Frontend/frontendSourceCode/cronjobs/eod.cron - Crontab that runs the cleanup code for Orders that are placed as Good for the Day
code/Frontend/frontendSourceCode/cronjobs/rank.cron - Crontab that runs the ranking scripts at the end of each day.
================================ END FRONTEND =====================================

