StockEye

Version: 1.3
Release Date: February 5, 2021
Last Updated: April 6, 2021
Authors: Campbell Leckie, Roy Ceyleon, Tyler Price, Jeff Kolnick
Editors: Yasmine Ali, Ruth Schmidt, Anshul Khatri, Brayden Mckay, Syed Ahmed, Mohsin Malik

(1.1) Project Summary

StockEye is a web application that aggregates and analyses tweets related to the stock market from the popular social media platform Twitter, and offers information regarding the public sentiments of stocks to its users. StockEye seeks to serve its audience in multiple ways. For one, Twitter is a valuable source of data due to the impact that public opinion has on the market, enabling users to make more informed investment decisions. Additionally, this platform will save users time, as they will no longer be required to research and analyse the Twitter sentiments themselves.

(1.2) Evolution of the SPMP

As the project progresses certain sections of the SPMP document are expected to be updated. These sections include:

• (1.2) Project Deliverables - Deadlines and Adjusted Deadline may be changed as the project progresses.
• (2) Definitions - As the project progresses, further terminology will be appended as necessary in order to ease comprehension of this document.
• (3) References - If any additional resources are utilized, they will need to be appended.
• (4.1) Project Responsibilities - The roles of individual team members may differ as the project progresses.
• (6.2) Methods, Tools, and Techniques - Method, tools and techniques required may be revised as the project progresses.

All modifications to the SPMP are to be recorded under the “Change History” heading. Each entry must include a brief description detailing the revision, a timestamp, and the group member who authored it.

(4.1) Roles and Responsibilities

The deliverables and the group members designated responsible:

Deliverable	Chief	Contributors	Testers
Specifications Document	Yasmine Ali	Yasmine Ali Ruth Schmidt Tyler Price Syed Ahmed	Campbell Leckie Roy Ceyleon Mohsin Malik
SPMP	Campbell Leckie	Campbell Leckie Tyler Price Nicolas Mills Roy Ceyleon Jeff Kolnick	Yasmine Ali Ruth Schmidt Anshul Khatri Brayden Mckay Syed Ahmed
Requirements Document	Anshul Khatri	Anshul Khatri Jeff Kolnick Michael Okenye Perikles Tsikrikis Mohsin Malik	Campbell Leckie Ruth Schmidt Nicolas Mills Roy Ceyleon
Analysis Document	Nicolas Mills	Nicolas Mills Syed Ahmed Perikles Tsikrikis Roy Ceyleon Michael Okenye	Anshul Khatri Jeff Kolnick Yasmine Ali Ruth Schmidt Brayden Mckay
Design Document	Leron Bergelson	Leron Bergelson Brayden Mckay Campbell Leckie Yasmine Ali Anshul Khatri	Michael Okenye Ruth Schmidt Perikles Tsikrikis Mohsin Malik Syed Ahmed Roy Ceyleon
Implementation Front End	Ruth Schmidt	Brayden Mckay Michael Okenye Nicolas Mills Roy Ceyleon Ruth Schmidt Syed Ahmed Tyler Price Yasmine Ali
Implementation Back End	Leron Bergelson	Anshul Khatri Campbell Leckie Leron Bergelson Roy Ceyleon Mosin Malik Nicolas Mills Perikles Tsikrikis Ruth Schmidt
Implementation Model Training	Anshul Khatri	Anshul Khatri Campbell Leckie Jeff Kolnick Perikles Tsikrikis Syed Ahmed Yasmine Ali
Implementation Unit Testing	Michael Okenye	Anshul Khatri Campbell Leckie Brayden Mckay Leron Bergelson Roy Ceyleon Mosin Malik Michael Okenye Nicolas Mills Ruth Schmidt Jeff Kolnick Perikles Tsikrikis Syed Ahmed Yasmine Ali Tyler Price

Additional responsibilities outside the scope of deliverables:

Role	Group Member	Responsbilities
Meeting Chair	Ruth Schmidt	Chairs all group meetings. Summarizes group meeting discussions. Sets meeting agendas.
Communications Correspondent	Yasmine Ali	Handles all communications with the Client.
Documentation Site Manager	Roy Ceyleon	Manages and updates the Documentation Site. Converts all Google Doc drafts of deliverable documents to HTML. Reviews final quality of all deliverable documents.

(5.1) Objectives and Priorities

The objective of this project is to produce a streamlined web-based platform for investors and market enthusiasts, to view the prospective performance of popular stocks based on the analysis of Twitter sentiments. Top priorities include project completion within the specified deadline and the implementation of a fully-functional application.

(5.2) Monitoring and Reporting Mechanisms

• Weekly meetings on Thursdays and Sundays.
• Meetings are separated out into development teams.
• Group meetings will be held as needed to approve deliverables and update other teams on progress.
• To ensure credit is given where due, all contributions are to be logged in a spreadsheet using Google Sheets.
• The contribution log can be viewed through the Contribution Tracker.
• Communication via the StockEye Discord server.
• Individual text channels for each deliverable allowing clear communication between teams.
• Documents collaborated upon utilizing Google Docs and ClickUp.

(5.3) Activity Plan

Activity	Plan
SPMP	Read through the IEEE documentation and determine relevant and pertinent pieces of information to incorporate into the SPMP. Discuss and write the SPMP using Google Docs. Revise and finalize the written SPMP document. Convert and transfer the SPMP document to the Documentation Site. Update the SPMP as development progresses.
Requirements	Discuss and write the Requirements document for the StockEye application using Google Docs. Revise and finalize the written requirements document. Convert and transfer the requirements document to the Documentation Site.
Analysis	Research and determine the relevant and pertinent components for the Analysis document. Discuss, list, and define the entity/boundary/control objects and classes required. Determine the attributes of classes and relationships between the different classes and create models. Review models for completeness, correctness, and consistency. Write the Analysis document using Google Docs. Revise and finalize the written Analysis document. Convert and transfer the Analysis document to the Documentation Site. Update the Analysis as development progresses.
Design	Discuss and determine a list of design goals. Discuss objectives, generate visions of the StockEye GUI, and create prototypes. Decompose the StockEye application into the subsystems and determine in which subsystem the entity classes, identified in the Analysis document, belong to. Determine the necessary front-end and back-ends tools to be utilized. Write the Design document using Google Docs. Revise and finalize the written Design document. Convert and transfer the Design document to the Documentation Site. Update the Design as development progresses.
Front-end	Review prototypes found in the Design document. Implement the prototypes. Test the implementation for quality and correctness.
Back-end	Review and follow the Design document and determine necessary components of the Back-end to achieve objectives. Implement the necessary components of the Back-end. Test the implementation for quality and correctness. Ensure thorough and proper documentation of code.

(6.1) Process Model

The project was initiated on January 15, 2021 and will be terminated with the end of the Winter 2021 semester at Wilfrid Laurier University, on April 12, 2021.

The project uses an object-oriented design methodology process and UML for the design and documentation of the software. The development process is organized into several activities, wherein the responsibilities of each activity, such as contributing and testing, are delegated to a subset of team members. The products of these activities are finalized upon the approval of the designated Chief of the respective deliverable, along with a majority of the contributing members. The approved documents are considered work products and will become part of the official software documentation.

Major milestones are the completion of all major pieces of documentation (Requirements, Analysis, Design etc.) and the fully-functional implementation of the application.

(6.2) Methods, Tools, Techniques

A listing of all the development methodologies, software, programming languages, and other tools used for the completion of project deliverables and non-deliverables:

Communication, Collaboration, and Organization

• Discord
• ClickUp
• Google Sheets
• Google Docs

Programming Languages

• Python 3
• HTML
• CSS
• SQLite

Version Control

• GitHub

Integrated Development Environments (IDEs)

• Microsoft Visual Studio Code
• Eclipse

Web Frameworks

• Django Python

GUI Prototyping

• Figma

Other

• Jupyter Notebook
• Twitter API
• Heroku

(6.3) Infrastructure plan

The StockEye web application will be hosted on the cloud application platform Heroku. Linking Heroku to the StockEye repository on GitHub enables automatic synchronization between the production environment and GitHub master branch, removing infrastructure maintenance inherent to alternative solutions such as IaaS.