(CMP020N207S) Software Architecture & Design
- Keisha Geyrozaga (GEY23581805) GitHub Profile
- Anderson Ricardo Gomes Ballestroz (GOM21551647) GitHub Profile
- Clement Irivibeguai (IRI22514509) GitHub Profile
- Angelo Bongon (BON22529894) GitHub Profile
This repository contains the development of our S.A.D GROUP COURSEWORK ASSIGNMENT 'SHARE PRICE COMPARISON WEB APPLICATION'. The project is built in Java using 'IntelliJ IDEA' and follows architectural principles such as Simple Architecture, Clean Architecture, and Service-Oriented Architecture (SOA). In addition to this, we have included numerous files evidencing our commitment to producing well-structured, organised deliverables. Using a Kanban board, we allocated tasks between us fairly and equally amongst ourselves. This board contains the product backlog, which will be updated with additional tasks according to the immediate sprint checklist—ensuring we prioritise the current sprint’s deadlines before moving on to the next.
The following information will aim to summarise project information in accordance with the 'Software Architecture & Design' assignment brief.
- Keisha - Product Owner
- Anderson - Scrum Master
- Clement & Angelo - Developers
The "SHARE PRICE COMPARISON WEB APPLICATION" is a Java-based financial analysis tool that enables users to track and compare historical stock prices of different companies. The system retrieves stock price data from an external API, stores it persistently for offline access, and presents stock information in a graphical format. Designed with 'Simple Architecture' and 'Clean Architecture' principles in mind, the application ensures it takes a structured approach to financial data visualisation. The project aims to allow users to view and compare stock/share performance of different companies over time. Relying on agile development methodologies, such as 'Kanban' and 'Scrum', we aim to implement sound architectural foundations, core functionlities, and system integrations to achieve all coursework objectives.
- Fetch daily share price data from an API
- Store retrieved data persistently in a **database store of **SQLite
- Display interactive stock price charts
- Compare stock performance between two different companies
- Ensure a basic, functional UI for user interaction
**SQLite was chosen as our database as we will be storing fetched stock prices in a relational format. This means we will need a database that is capable of handling large datasets, supporting scalability for long-term storage, and integrating seamlessly with our chosen IDE, 'IntelliJ IDEA'. Additionally, we will be able to use SQL queries to easily access, filter, sort, and retrieve stock prices. Thus, making SQLite the most reasonable choice to opt for.
This will establish the technologies that will be using to model our current progress, team communication, and develop our project to the fullest.
- Programming Languages: HTML, CSS, JavaScript
- IDE: IntelliJ IDEA
- Version Control: Git & GitHub
- Database: SQLite
- External API: 'Yahoo Finance' Stock Price API
- Task Management: GitHub Projects
We are following the 'Scrum' methodology, using GitHub Project for task management and sprint tracking. Our main programming language will be JavaScript and 'IntelliJ IDEA' will be the IDE we develop the program in. Our team aims to maintain regular communications through a WhatsApp groupchat for quick updates on current progress, and, 'Microsoft Teams' for weekly team meetings.
Our architecture follows 'Simple Architecture' principles with the following as core components:
- API Service - Fetches stock prices from 'Yahoo Finance'
- Database Layer - Stores historical stock data
- Graphing Module - Generates the visual comparisons
- UI Layer - Basic frontend for displaying data
Using PlantUML, we created a component UML diagram to illustrate the structure of key components we plan to use in our stock price comparison web application project. It provides us with a graphical representation and a visual overview of the system's archietcture, highlighting the interactions & relationships between key components, as well as maintaining the application's core functionalities.
Refined through repetitive renditions and lecturer feedback, we finalised our component UML diagram to reflect the expectations of our project and what we expect it to be comprised of, based on our existing understanding on stock price web applications. The revised diagram encapsulates key functional components, including the 'StockDataProvider' compound component subsystem, which integrates both 'SQLiteStorage' and ‘Persistent Storage’ for data retrieval and persistence.
This is the Kanban board we use to track progress, organise tasks, and ensure smooth workflow management. Each column represents a different stage of the process, helping us visualise work in progress and prioritise tasks effectively. Kanban Board Link
As a team, we were able to effectively distribute task responsibilities amongst ourselves and work towards meeting 'Sprint 1' checklist objectives outlined in the coursework assignment brief. Through clear and consistent communication via WhatsApp and Microsoft Teams, we utilised GitHub and IntelliJ to achieve our development goals efficiently.