Golden-Portfolio System Requirements Document

1. Introduction

The Golden-Portfolio project is an internal tool designed for an investment advisory firm to track individual client investment portfolios across various asset classes. It computes returns and risk metrics and displays per-client dashboards. This document outlines the system requirements for the Golden-Portfolio project, ensuring it meets the needs of advisors within the firm.

2. System Overview

Golden-Portfolio is a web application that provides advisors with a comprehensive view of client portfolios. It supports tracking of investments across asset classes such as mutual funds, equities, fixed income, and IPOs. The system integrates with a live pricing API to provide real-time updates on asset values, ensuring accurate and up-to-date portfolio assessments.

3. Functional Requirements

• As an Advisor, I should be able to view a list of clients with a summary of their total portfolio value, overall XIRR, and allocation snapshot.
• As an Advisor, I should be able to access a detailed dashboard for each client, including holdings table, allocation pie/bar chart, value-over-time line chart, concentration view, and benchmark vs. portfolio comparison.
• As an Advisor, I should be able to filter client portfolios by asset class and date range.
• As an Advisor, I should be able to import client data via CSV/Excel upload using a downloadable template.
• As an Advisor, I should be able to manually add or edit individual holdings and transactions.
• As an Advisor, I should be able to integrate and view live pricing data for assets using a specified API.
• As an Advisor, I should be able to view calculations for current value per holding and per client, absolute return, XIRR, allocation breakdown, concentration, and benchmark comparison.
• As an Advisor, I should be able to configure and flag any single holding above a specified concentration threshold.
• As an Advisor, I should be able to handle partial sells, SIPs, and multiple lots per instrument.

4. User Personas

• Advisor: A financial advisor within the firm who uses the system to manage and analyze client portfolios.

5. Core User Flows

• Advisor logs into the system -> views client list -> selects a client -> accesses detailed dashboard -> filters data as needed -> updates holdings or transactions -> reviews live pricing updates -> performs analysis using provided metrics.

6. Visuals Colors and Theme

• primary: #2A9D8F (Teal)
• primary_light: #A8DADC (Light Teal)
• secondary: #E76F51 (Coral)
• accent: #F4A261 (Orange)
• highlight: #E9C46A (Gold)
• bg: #F1FAEE (Off White)
• surface: rgba(42, 157, 143, 0.8)
• text: #264653 (Dark Blue)
• text_muted: #8D99AE (Gray)
• border: rgba(38, 70, 83, 0.2)

7. Signature Design Concept

The Golden-Portfolio homepage will feature an interactive "Investment Galaxy" concept. Advisors can navigate through a 3D galaxy where each star represents a client portfolio. Hovering over a star reveals a quick summary, while clicking on it zooms into a detailed view of the client's investments. The galaxy will be built using @react-three/fiber for 3D rendering, with smooth transitions and animations powered by framer-motion. This immersive experience will make portfolio management engaging and intuitive.

8. Interaction Model & Motion Direction

The landing page will employ a "parallax" interaction model, with layered depth via scroll. Decorative elements like stars and constellations will translate at different speeds, creating a dynamic and visually rich first impression. Internal pages will maintain a "static" layout for clarity and ease of data analysis.

9. Non-Functional Requirements

• The system must ensure data accuracy and integrity, particularly in financial calculations.
• The application should be responsive and accessible on various devices and screen sizes.
• The UI should be clean and professional, adhering to the specified color theme.

10. Tech Stack

• Frontend: React for Web
• Backend: Python, FastAPI
• Database: MySQL or MariaDB, with alembic for migrations
• Live Pricing API: Integration with a specified API for real-time data
• Local Orchestration: Docker, docker-compose
• Server-side Orchestration: Kubernetes

11. Assumptions and Constraints

• The application is for internal use only by advisors.
• Live pricing API integration is required; manual entry is a fallback if integration is not feasible.
• Data storage and exposure must be communicated before deployment.

12. Glossary

• XIRR: Extended Internal Rate of Return, a method to calculate returns on investments with irregular cash flows.
• SIP: Systematic Investment Plan, a method of investing a fixed sum regularly in mutual funds.
• NAV: Net Asset Value, the value per share of a mutual fund or an ETF.

This document provides a comprehensive overview of the system requirements for the Golden-Portfolio project, ensuring it meets the needs of the firm's advisors.