-## Minimum Features
-* `RESTful` web service which consumes requests from a front-end web application and caches each request and the respective response to a database.
-* The application must support a login functionality.
+Use your `git bash` terminal to clone a copy of the project to the local directory of your choosing.
+
+Step 2: This project uses MySql to persist login credentials and requires some configuration to do so. First, navigate to your MySql Workbench and take note of the username, password (will not be shown), and host location needed to to access the DBMS.
+
+We will need to create a database for the program to use, so enter the DBMS and create a database by writing one simple statement. Here I have chosen to call the database `casestudy`. So, my statment is `create database casestudy;` Execute the statement and make sure it is successful by checking the output.
+
-## Developmental Notes
+Step 3: Now we will make sure the program points to the correct database. Navigate to the project directory and open the `pom.xml` file in your IDE.
+
-### Tech Stack Selection
-* Select at least 1 technology from each of the following categories:
- * **Version Control System**
- 1. Github
- 2. Bitbucket
-
- * **Wireframe**
- 1. Mockflow
- 2. Balsamiq
- 3. Lucidcharts
+Once the project is built, navigate to the `application.properties`. If needed, change the `spring.datasource.url`, `spring.datasource.username`, and `spring.datasource.password` to reflect your own settings noted in step 2.
+
- * **Frontend**
- 1. Angular
- 2. React
- 3. Vue.JS
-
- * **Business Logic**
- 1. Java
- 2. TypeScript
+Step 4: Run the project. This can be accomplished by pressing `Shift + F10` if you're on a PC. Alternatively, in the menu on top of the window, click `Run` → `Run 'CasestudyApplication'`. If you have maven installed, you can use the command `mvn spring-boot:run`. If something is already running on port 8080, run the `kill-8080.bat` or `kill-8080.sh` included in the project files. Ensure that the project begins running.
+
- * **WebServer Implementation**
- 1. Spring Boot
- 2. At least 1 [backing service](https://12factor.net/backing-services) API
+Step 5: Open an internet browser and navigate to `localhost:8080/login`. This is where you will login after creating an account. Click `Create an account` under the login button. This will redirect you to the registration page. Create a username and password (username must be 6-32 characters, password must be at least 8 characters).
+
- * **Data Layer**
- 1. MySQL
- 2. PostgreSQL
- 3. MariaDB
+Upon successful creation of a user, you will be redirected to the welcome screen.
+
- * **Web Server Cloud Deployment**
- 1. Heroku
- 2. AWS EC2 Instance
-
- * **Web Application Cloud Deployment**
- 1. Netlify
- 2. AWS EC2 Instance
+From here you can use the links in the navbar to navigate to the pages available to logged-in users.
+# Exploring the program
+Market News: The market news page allows a user to see the 20 most recent news articles for the entire market provided by Finnhub's API.
+
+Company Overview: The company overview page is the most complex and powerful page of the project. Upon navigating to the page, it is auto-populated with data for Amazon.
+
-### Installation
-* It is advised that you make install each of the following technologies to ensure that are at least accessible
- * Install [NodeJs](https://nodejs.org/en/).
- * Install [Angular](http://angular.io/).
- * Install [AngularCli](https://cli.angular.io/).
+However, a user may use the search bar at the top to enter the symbol/ticker of a desired stock, such as 'TSLA' for Tesla, and the page will show data for that particular stock. This page uses 3 seperate API's to populate data (Finnhub, AlphaVantage, and IEXCloud).
+
+
+One of the data points provided is a 5 day price chart of the stock price of the security. This is done using the Chart.js open-source library. (Note: Sometimes the chart fails to render on load, however if you resize the window, the chart will populate with data.)
+
+
+Under the chart is the company's description and general information about the company, financial information, and dividend information.
+
+
+On the bottom of the page is news articles directly related to the security specified. The program is designed to fetch the last month's worth of articles however, it also displays a max of 21 articles so you don't have hundreds of articles on one page for companies like Amazon with large quantities of articles.
+
+When you're done using the program just click the `Logout` link at the top right of the window (far right of the navbar) and you will be logged out and redirected to the login page, where you will see a message displaying that you have successfully logged out.
+
+
+# How it works
+Due to the constant changing of information in the stock market, the stock data is not persisted into the database. Each time you load the market news page one API call is made to Finnhub. Loading the company overview page and each subsequent change of stock symbols makes a total of 4 API calls (AlphaVantage: 1, Finnhub:1, IEXCloud: 2). Since data is not being persisted to the database, API calls are made in JavaScript and displayed in HTML. JavaScript receives JSON data from the external API's and uses templates created by me to display the parsed JSON elements in their desired locations. Due to the use of free tokens from API providers, you may hit the limit for API calls and get an error instead of receiving company data if too many API calls are made in a short period of time.
+
+Login functionality is made possible with Spring Security. The program uses custom login and registration JSP pages to gather information from the user.
+
+###### Technologies used
+* Spring MVC → Java
+* JSP → HTML, CSS, Js
+* MySQL
+* Git
\ No newline at end of file
diff --git a/README_deliverables.md b/README_deliverables.md
deleted file mode 100644
index 4bb20a97f..000000000
--- a/README_deliverables.md
+++ /dev/null
@@ -1,52 +0,0 @@
-## Deliverables
-
-### Trello Board
-* To begin your case study, create a Trello board
-* Please ensure the instructor has access to this Trello board.
-* This board will be used to track progress and evaluate required effort of tasks.
-* Ensure the board has at least 5 columns accounting for each of the following
- * `Ideation`
- * This column will first contain cards describing a potential application to be built.
- * Upon concept approval, this column will be re-purposed to describe potential features of the approved application.
- * `Backlog`
- * This column will contain cards describing work that **will not be** done in a near-future, but **must be done** eventually for the product to be considered completed
- * `Upcoming`
- * This column will contain cards describing work that **will not be** done in the current-sprint commitment, but **will be committed to** in the upcoming-sprint commitment.
- * `Current`
- * This column will contain cards describing work that **will be** done in the current-sprint commitment.
- * `In Review
- * This column will contain cards describing work that **need to be reviewed** to be considered **done**.
- * `Completed`
- * This column will contain cards describing work that has been reviewed and is considered completed
-
-### Database
-* MariaDB is the suggested dialect
-* This deliverable includes creating a database that reflects the website you have decided to create
-* Schema diagram: a visual representation of your database
-* Database file creation (`.sql`): Queries used to create the database
-
-
-### Core Java & JPA
-* This deliverable includes creating a back-end environment that is composed of different Java classes
- * Models: Java classes that represent an entity and are used to transfer data related to an entity, create multiple queries, and represent the database as an object-oriented model
- * Persistence.xml: This file configures the Java classes that are going to be using JPA to interact with the database.
- * Persistence Java Class: A static class that allows the application to create a persistent object which can be used to interact with the database.
- * Service Class or Data Access Objects (DAO): Java classes that are composed of one or more functions and have direct access to the database by using JPA persistent object. Each function in a DAO class interacts with the database differently.
- * Custom Exceptions: Java classes that allow you to describe an error while the application is running.
- * Utilizes: Java classes that hold constant variables (Variables that never change from its initial value). The value of these variables can be requested parameters, Database queries used in the DAO, name of HTML pages, or URL patterns to forward a request to.
-
-
-### HTML5/CSS3
-* This deliverable includes creating every page required by the given case study
-* HTML5: Use HTML for static and dynamic pages and markup the structure of every page.
-* CSS3: Use CSS3 to style your HTML pages and make sure to take into consideration the knowledge acquired from the visual design lessons.
-
-
-### Spring MVC
-* This deliverable includes connecting no. 1, 2 and 3 deliverables to function together
- * Spring MVC: Responsible for responding to a request made by the user. This can be login, registration, etc. When using Spring MVC make sure to use at least the following functionalities: different type of session management, annotation-based controller, exception handling, models, model attributes.
-
-
-### Junit (Test all DAO classes)
-* This deliverable includes creating a test class for each DAO available and creating a test case in the test class for each function inside the DAO
- * Junit: A Java framework responsible for performing unit testing against every DAO class available. There should be a test class for every DAO and inside the test classes, there should be at least one test case for every function inside the DAO classes. When using JUnit make sure to use the following functionalities: Suite classes, Runner, Feature life cycle, Test, Parameterized classes, Java Hamcrest library.
diff --git a/README_plagiarism.md b/README_plagiarism.md
deleted file mode 100644
index 5b071dae3..000000000
--- a/README_plagiarism.md
+++ /dev/null
@@ -1,20 +0,0 @@
-### A Note on Plagiarism
-* You are encouraged to ask others, including students, instructors, and StackOverflow, for help. However, it is NOT ACCEPTABLE TO COPY another person's code and submit it as your own. More importantly, it is detrimental to your learning and growth.
-* All of the following are considered plagiarism or cheating:
- * Turning in work that is not your own.
- * Turning in someone else's work as your own.
- * Hiring, or paying someone to do your work for you.
- * Copying words or code without giving credit.
- * Building or copying someone else’s idea without their knowledge or giving credit.
- * Giving incorrect information about a source.
- * Changing words, variable names, etc. but copying the code or files of a source without giving credit.
- * Copying so many ideas or code blocks from a source that it makes up the majority of your work, whether you give credit or not.
- * Failing to put a quotation in quotation marks.
-
-
-* In an effort to not plagiarize, credit for this content goes to:
-* [Plagiarism.org](plagiarism.org), specifically the “plagiarism 101” section. The content was adapted for the code. For more information, please see:
- * [What is Plagiarism](http://www.plagiarism.org/plagiarism-101/what-is-plagiarism)
- * [Types of Plagiarism](http://www.plagiarism.org/plagiarism-101/types-of-plagiarism)
- * [How do I safely write code in my own 'words' and not plagiarize?](http://programmers.stackexchange.com/questions/80167/how-do-i-safely-write-code-in-my-own-words-and-not-plagiarize)
- * [Avoiding Plagiarism: Writing Computer Code](http://www.upenn.edu/academicintegrity/ai_computercode.html)
diff --git a/README_suggested-project-topics.md b/README_suggested-project-topics.md
deleted file mode 100644
index 9b2ac965e..000000000
--- a/README_suggested-project-topics.md
+++ /dev/null
@@ -1,54 +0,0 @@
-
-## Suggested Project Topics
-
-### (Suggested Project Topic 1) TCP Application
-
-#### User Stories to Fulfill
-* As a client, (not logged in) I
- * can send messages to a _peer_.
- * can view default channels
- * can view all accessible channels
- * can view messages live as they are received
-
-',
+ '
'
+ ].join("\n");
+
+ $("#newsContainer").append(template);
+
+ if (i == 20) { break };
+ }
+ })
+}
+
+function timeConverter(UNIX_timestamp) {
+ var a = new Date(UNIX_timestamp * 1000);
+ var months = ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'];
+ var year = a.getFullYear();
+ var month = months[a.getMonth()];
+ var date = a.getDate();
+ var hour = a.getHours();
+ var period = 'AM';
+ var min = a.getMinutes();
+ if (min < 10) {
+ min = '0' + min;
+ }
+ if (hour > 12) {
+ hour = hour - 12;
+ period = 'PM';
+ }
+ else if (hour == 12) {
+ period = 'PM';
+ }
+ else if (hour == 0) {
+ hour = 12;
+ }
+ var time = date + '-' + month + '-' + year + ' ' + hour + ':' + min + period;
+ return time;
+}
\ No newline at end of file
diff --git a/src/main/resources/validation.properties b/src/main/resources/validation.properties
new file mode 100644
index 000000000..9309bdf06
--- /dev/null
+++ b/src/main/resources/validation.properties
@@ -0,0 +1,5 @@
+NotEmpty=This field is required.
+Size.userForm.username=Username require between 6 and 32 characters.
+Duplicate.userForm.username=Someone is already using this username.
+Size.userForm.password=Passwords require at least 8 characters.
+Diff.userForm.passwordConfirm=These passwords do not match.
\ No newline at end of file
diff --git a/src/main/webapp/WEB-INF/jsp/company-overview.jsp b/src/main/webapp/WEB-INF/jsp/company-overview.jsp
new file mode 100644
index 000000000..81417b8f5
--- /dev/null
+++ b/src/main/webapp/WEB-INF/jsp/company-overview.jsp
@@ -0,0 +1,178 @@
+
+
+
+
+
+
+
+
+ ',
+ '
',
+ '',
+ '
',
+ '
',
+ '',
+ '
',
+ '',
+ '
',
+ '' + title + '
', + '' + summary + '
', + '', + '
+
+
+
+
+
+
+
+
+
+ 
+
+
+
+ IBM
+
+
+
+ Name: International Business Machines Corporation
+Asset Type: Stock
+Exchange: NYSE
+Currency: USD
+Sector: Technology
+Industry: Information Technology Services
+52 Week High: 158.75
+52 Week Low: 90.56
+
+
+
+ +
+
+
+ +
+ Description
+
+ International Business Machines Corporation operates as an integrated solutions and services company
+ worldwide. Its Cloud & Cognitive Software segment offers software for vertical and domain-specific
+ solutions in health, financial services, and Internet of Things (IoT), weather, and security
+ software and services application areas; and customer information control system and storage, and
+ analytics and integration software solutions to support client mission critical on-premise workloads
+ in banking, airline, and retail industries. It also offers middleware and data platform software,
+ including Red Hat, which enables the operation of clients'
+ hybrid multi-cloud environments; and Cloud Paks, WebSphere distributed, and analytics platform
+ software, such as DB2 distributed, information integration, and enterprise content management, as
+ well as IoT, Blockchain and AI/Watson platforms. The company's
+ Global Business Services segment offers business consulting services; system integration,
+ application management, maintenance, and support services for packaged software; finance,
+ procurement, talent and engagement, industry-specific business process outsourcing services; IT
+ infrastructure and platform services. Its Global Technology Services segment provides project,
+ managed, outsourcing, and cloud-delivered services for enterprise IT infrastructure environments;
+ and IT infrastructure support services. It's
+ Systems segment offers servers for businesses, cloud service providers, and scientific computing
+ organizations; data storage products and solutions; and z/OS, an enterprise operating system, as
+ well as Linux. Its Global Financing segment provides lease, installment payment, loan financing,
+ short-term working capital financing, and remanufacturing and remarketing services. It was formerly
+ known as Computing-Tabulating-Recording Co. and changed its name to International Business Machines
+ Corporation in 1924. It was founded in 1911 and is headquartered in Armonk, New York.
+
+
+ + +
+
+
+
+
+
+ General Info
++
Address: One New Orchard Road, Armonk, NY, United States, 10504 +
+# of Full-time Employees: 352600
+Fiscal Year End: December
+Latest Quarter: 2020-06-30
+
+
+
+ Financials
++
Market Cap: 109656989696
+Revenue TTM: 75499003904
+Gross Profit TTM: 36489000000
+Profit Margin: 0.1043
+PE Ratio: 14.1633
+PEG Ratio: 7.8951
+Trailing PE: 14.1633
+Forward PE: 10.1833
+Analyst Target Price: 135.19
+
+
+
+ Dividends
++
Dividend per Share:
+Dividend Yield: 0.0525
+Dividend Date: 2020-09-10
+Ex Dividend Date: 2020-08-07
+Forward Annual Dividend Rate: 6.52
+Forward Annual Dividend Yield: 0.0525
+Payout Ratio: 0.7358
++
+
+
+
+
+
+ Company News
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/src/main/webapp/WEB-INF/jsp/market-news.jsp b/src/main/webapp/WEB-INF/jsp/market-news.jsp
new file mode 100644
index 000000000..43afaabfa
--- /dev/null
+++ b/src/main/webapp/WEB-INF/jsp/market-news.jsp
@@ -0,0 +1,65 @@
+
+
+
+
+
+
+
+
+
+
+
+
+Welcome!
+ + +
+
+
+
+
+
+
\ No newline at end of file
diff --git a/src/main/webapp/WEB-INF/jsp/welcome.jsp b/src/main/webapp/WEB-INF/jsp/welcome.jsp
new file mode 100644
index 000000000..6f4f32d2e
--- /dev/null
+++ b/src/main/webapp/WEB-INF/jsp/welcome.jsp
@@ -0,0 +1,83 @@
+<%@ taglib prefix="spring" uri="http://www.springframework.org/tags" %>
+<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>
+<%@ taglib prefix="form" uri="http://www.springframework.org/tags/form" %>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Create your account
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/src/test/java/com/devos/perscholas/casestudy/CasestudyApplicationTests.java b/src/test/java/com/devos/perscholas/casestudy/CasestudyApplicationTests.java
new file mode 100644
index 000000000..df228fbaa
--- /dev/null
+++ b/src/test/java/com/devos/perscholas/casestudy/CasestudyApplicationTests.java
@@ -0,0 +1,13 @@
+package com.devos.perscholas.casestudy;
+
+import org.junit.jupiter.api.Test;
+import org.springframework.boot.test.context.SpringBootTest;
+
+@SpringBootTest
+class CasestudyApplicationTests {
+
+ @Test
+ void contextLoads() {
+ }
+
+}
+
+
+
+
+
+
+
+
+Welcome ${pageContext.request.userPrincipal.name}
+ +Hello, and welcome to Nick's Stock Market Case Study application.
+To get started, please select 'Market News' or 'Company Overview' in the navbar at the top.
+Market News will show you 20 of the most recent news articles about publicly traded companies. Company + Overview will allow you to enter a symbol into the search bar see information related to that company.
+When you are finished exploring company information, click 'Logout' on the far right side of the navbar.
+ +