📑 Table of Contents

1. Project Goal
2. SkyTrader24 as SaaS
3. Roadmap
4. Technologies Used
   • Frontend
   • Backend
   • Database
   • DevOps
5. Architecture
6. Installation and Setup
7. License

---

🎯 Project Goal

The goal of the application is to simplify the process of gathering information on the capital market, world events, and analyzing their impact on stock markets, with minimal user effort.
SkyTrader24 aggregates and analyzes content from platforms like YouTube and news portals to generate automatic summaries and market forecasts.

---

🌐 SkyTrader24 as SaaS

SkyTrader24 will be provided as a Software as a Service (SaaS) platform. This means:

• No Installation Required:
  Users can access the application via a web browser without needing to set up the software locally.

• Subscription-Based Access:

  • Basic functionality will be available for free.
  • Premium features (e.g., advanced analysis, custom notifications, and detailed reports) will require a subscription.

• Automatic Updates:
  SaaS ensures the latest features and improvements are available instantly to all users without any manual updates.

---

📅 Roadmap

The full roadmap with detailed features and plans is available here.

---

🛠️ Technologies Used

Frontend

• Angular 18.2: Framework for building web applications
• TailwindCSS: For user interface styling
• vis.js: For visualizing network correlations
• chart.js, d3.js: For visualizing market data

Backend

• Java 21 (GraalVM): Runtime environment
• Spring Boot 3.2.2: REST API architecture
• Maven: Project dependency management

Database

• PostgreSQL: Storing user data, authentication, transactional data
• MongoDB: Storing dynamic data, transcripts, analyses

DevOps

• Docker: Containerization
• GitHub Actions: CI/CD
• Kubernetes: Cloud scaling
• Terraform/Tofu: Infrastructure as code management
• AWS: Cloud services

API Integrations

• YouTube Data API: Retrieving video data
• Yahoo Finance API: Market data integration
• SMS Gateway: Sending SMS messages
• SMTP Email Integration: Sending emails
• Whisper: Processing video transcripts

---

🏗️ Architecture

SkyTrader24 is built as a modular monolith with a Spring Boot backend handling REST API requests from an Angular front end. Migration to microservices is planned for future scalability.

---

🧑‍💻 Installation and Setup

Prerequisites for Building

SkyTrader24 relies on multiple submodules to provide its full functionality. Some of these submodules are private and require access to build the application. Ensure you have the following:

1. Access to Private Repositories:

   • st24-backend
   • st24-etl
   • st24-frontend
   • st24-infrastructure

   (Without access to these submodules, the application cannot be fully built or deployed)

2. Clone the repository:

git clone --recursive https://github.com/mcblankenburg/SkyTrader24.git

If you’ve already cloned the repository without submodules, initialize them with:

git submodule update --init --recursive

2. Follow instructions for setting up the backend and frontend in their respective submodules.
   1. manually building each service from README.md
   2. using scripts from the scripts/ directory

---

📜 License

This project is proprietary. See the LICENSE.md file for details.