StockEye

User Documentation

Version: 1.0
Release Date: April 17, 2021
Last Updated: April 17, 2021
Authors: Roy Ceyleon, Jeff Kolnick
Editors: Roy Ceyleon

(1) Introduction
(2) Registration
(3) Log in
(4) Trending
(5) Watchlists

(5.1) Creating Watchlists
(5.2) Managing Watchlists

(6) Profile Settings
(7) Comptability

(1) Introduction

We Help You Beet the Market!

Stockeye is a web application that aggregates and analyses tweets that are related to the market from the popular social networking service Twitter, offering information regarding the public sentiments of stocks to its users. StockEye is thus intended to be another tool in an investor's repertoire for market research.

(2) Registration

Registering an account provides the user access to the Watchlist feature.

In the Registration page, the user is presented with the following fields:

Field	Details
Username	Desired account username. Used when logging-in. Username cannot already be existing.
Password	Desired account password. Input password cannot be too similar to the username provided. Input password must contain at least 8 characters. Input password cannot be a commonly used password. Input password cannot be entirely numeric.
Confirm Password	Desired account password. Must exactly match the input in the Password field.
Email	Account email address. Used for password recovery and watchlist notification purposes. (Currently not supported)

For all the cases listed below, you will be presented with the following simple message: Please ensure valid registration information is provided.

Input Password requirements not met.
Input Username has already been used by another registration.

(3) Log in

The Log in page is used to sign-in.

In the Log in page, the user is presented with the following fields:

Field	Details
Username	Account username. Case-insensitive.
Password	The account password. Case-sensitive.

(4) Trending

The Trending page displays the most popular stocks based on Twitter sentiment. In other words, these are the stocks that are currently enjoying the most favourable reception from the Twitter community.

(5) Watchlists

This feature is only available after signing-in with an account.

(5.1) Creating Watchlists

A watchlist can be created by selecting the Create Watchlist button. Here the watchlist can be named and then any number of the available stock tickers may be selected by holding the ‘Ctrl’ key and clicking. Then click on Save Changes and the desired watchlist will be displayed. When viewed, stocks in a watchlist will show the number of positive sentiments in a green circle, and the number of negative sentiments in a red circle.

(5.2) Managing Watchlists

The user can make changes to their created watchlists by selecting the Manage Watchlists button. First, any created watchlist may be deleted by selecting its checkbox and then selecting the Delete Selected Watchlists button. New watchlists may also be created here by selecting the Create Watchlist button and following the above instructions.

Watchlists can be edited by clicking on the name of the desired Watchlist. By holding the ‘Ctrl’ key and clicking on desired stocks, the Watchlist will be updated to include these stocks instead of the original selections.

(6) Profile Settings

This page is only accessible after signing-in.

Perhaps a user's email address has changed, or they feel that their current password is no longer secure. No problem. StockEye makes it as simple as possible to make such crucial changes to their account through the Profile Settings page.

In the Profile Setting page the user is presented with a form with inputs for a new password and email address, which also displays email currently associated with their account. The user simply has to enter the desired details to be changed and click Save Changes. Yes, it's that simple!

(7) Compatibility

Stockeye is compatible with Chrome, Firefox, Chrome for Android.