System Requirements Document (SRD) for magma-stocks

1. Introduction

The magma-stocks project is a comprehensive stock market analytics platform designed to provide users with real-time and historical stock market data, portfolio tracking, watchlist creation, and advanced analytics. The platform integrates with external stock market APIs to deliver accurate and timely data while offering premium features through a subscription model. The system will include role-based access control (RBAC) to manage user permissions and ensure secure access to premium features.

This document outlines the system requirements, architecture, and design for the magma-stocks platform, tailored for the Indian market (IN) with currency defaults in INR and timezone considerations for IST.

2. System Overview

The magma-stocks platform is a full-stack web application built using Next.js for the frontend and FastAPI for the backend. It provides users with the ability to:

• Explore stock market data in real-time.
• Create and manage watchlists.
• Simulate investments and track portfolio performance.
• Access advanced analytics and premium features through a subscription model.
• Utilize role-based access control to manage permissions for different user roles (e.g., Admin, Premium User, Free User).

The system will integrate with external APIs (e.g., Alpha Vantage or Finnhub) for stock data and Razorpay/Stripe for payment processing. It will also include robust authentication and subscription management features.

3. Functional Requirements

• Authentication

  • As a User, I should be able to sign up and log in securely.
  • As a User, I should be authenticated using JWT tokens.
  • As a User, I should have my password securely hashed.

• Stock Listing

  • As a User, I should be able to view a list of trending stocks.
  • As a User, I should be able to search for stocks by symbol or company name.
  • As a User, I should be able to view stock price, percentage change, and basic information.

• Stock Detail Page

  • As a User, I should be able to view detailed stock information.
  • As a User, I should be able to view historical price charts and technical indicators.
  • As a User, I should be able to view company details and market news.

• Watchlist

  • As a User, I should be able to add stocks to my watchlist.
  • As a User, I should be able to remove stocks from my watchlist.

• Portfolio Tracker

  • As a User, I should be able to simulate investments and track profit/loss.
  • As a User, I should be able to view my portfolio value.

• Premium Features

  • As a Premium User, I should be able to access advanced indicators.
  • As a Premium User, I should be able to create unlimited watchlists.
  • As a Premium User, I should be able to export stock data.
  • As a Premium User, I should be able to access advanced analytics.

• Pricing and Checkout

  • As a User, I should be able to view a pricing page comparing free and premium plans.
  • As a User, I should be able to complete a checkout process using Razorpay or Stripe.
  • As a User, I should be able to manage my subscription.

• Role-Based Access Control

  • As an Admin, I should be able to manage user roles and permissions.
  • As a Premium User, I should have access to premium features based on my subscription.
  • As a Free User, I should only have access to basic features.

4. User Personas

1. Admin

   • Manages user roles and permissions.
   • Oversees subscription plans and payments.
   • Monitors system performance and analytics.

2. Premium User

   • Accesses all features, including advanced analytics, unlimited watchlists, and data export.
   • Manages their subscription plan.

3. Free User

   • Accesses basic features like stock listing, watchlist creation, and portfolio tracking.
   • Limited to a single watchlist and basic analytics.

5. Visuals Colors and Theme

• Primary Colors:
  • Deep Blue (#1E3A8A) for headers and navigation.
  • Vibrant Orange (#F97316) for call-to-action buttons.
• Secondary Colors:
  • Light Gray (#F3F4F6) for backgrounds.
  • Dark Gray (#374151) for text.
• Accent Colors:
  • Green (#10B981) for positive stock changes.
  • Red (#EF4444) for negative stock changes.

The theme will be modern and professional, with a focus on readability and data visualization.

6. Signature Design Concept

The magma-stocks homepage will feature an interactive stock market dashboard. Users will be greeted with a dynamic 3D globe that highlights major stock exchanges around the world. Hovering over a location will display real-time market data for that region, including top-performing stocks and indices.

The background will feature a subtle animated gradient that shifts based on the time of day (e.g., sunrise hues in the morning, cool blues at night). The dashboard will include animated charts that update in real-time, creating a sense of immersion and engagement.

Micro-interactions will enhance the user experience, such as:

• Buttons that "pulse" when hovered over.
• Watchlist cards that "flip" to reveal additional details.
• A glowing effect on the subscription button to draw attention.

This design will make the platform visually stunning and instantly memorable.

7. Non-Functional Requirements

• The system must handle at least 10,000 concurrent users.
• The platform should have a response time of less than 200ms for API calls.
• Ensure data security with encrypted communication (HTTPS) and secure storage of sensitive information.
• The system must be scalable to accommodate future growth.

8. Tech Stack

• Frontend: Next.js, React, TypeScript, Tailwind CSS, Shadcn UI, TanStack Query, Chart.js.
• Backend: FastAPI, Python, SQLAlchemy ORM.
• Database: PostgreSQL for relational data, Redis for caching.
• External APIs: Alpha Vantage or Finnhub for stock data, Razorpay/Stripe for payments.
• Authentication: JWT-based authentication.
• Deployment: Docker, Kubernetes.

9. Assumptions and Constraints

• The system will primarily serve users in India, with currency defaults in INR.
• External APIs will provide accurate and timely stock market data.
• Payment processing will rely on third-party services (Razorpay/Stripe).
• The platform will adhere to GDPR and other relevant data protection regulations.

10. Glossary

• RBAC: Role-Based Access Control.
• JWT: JSON Web Token.
• API: Application Programming Interface.
• ORM: Object-Relational Mapping.
• Redis: An in-memory data structure store used for caching.
• Alpha Vantage/Finnhub: External APIs for stock market data.
• Razorpay/Stripe: Payment gateways for processing transactions.