Finalised Projects

Author: SplinterSword

.github/workflows/backend-cd.yml

@@ -0,0 +1,31 @@
+name: cd
+on:
+    push:
+        paths:
+            - 'backend/**'
+        branches:
+            - main
+jobs:
+    deploy:
+        name: deploy
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Checkout code
+              uses: actions/checkout@v2
+
+            - id: 'auth'
+              uses: 'google-github-actions/auth@v2'
+              with:
+                credentials_json: '${{ secrets.GCP_CREDENTIALS }}'
+
+            - name: 'Set up Cloud SDK'
+              uses: 'google-github-actions/setup-gcloud@v2'
+
+            - name: 'Build and Deploy Image To Artifact Registry'
+              run: |
+                cd backend
+                gcloud builds submit --tag asia-northeast1-docker.pkg.dev/my-backends-459605/noirvest-backend-repo/noirvest-backend:latest
+
+            - name: Deploy to Cloud Run
+              run: gcloud run deploy noirvest-backend --image asia-northeast1-docker.pkg.dev/my-backends-459605/noirvest-backend-repo/noirvest-backend:latest --region asia-northeast1 --allow-unauthenticated --project my-backends-459605 --max-instances=4 --set-secrets=GOOGLE_API_KEY=NOIRVEST_GEMINI_KEY:latest,FINANCIAL_PREP_API_KEY=NOIRVEST_FINANCIAL_API_KEY:latest --set-env-vars=GOOGLE_GENAI_USE_VERTEXAI=FALSE 

Pipfile

@@ -1,2 +1,187 @@
-# NoirVest
-Making investing Easy
+# NoirVest - AI-Powered Investment Assistant
+
+[![Python](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/)
+[![Next.js](https://img.shields.io/badge/Next.js-13+-black.svg)](https://nextjs.org/)
+[![FastAPI](https://img.shields.io/badge/FastAPI-0.100+-green.svg)](https://fastapi.tiangolo.com/)
+
+NoirVest is an intelligent investment platform that leverages AI to simplify and enhance your investment journey. Whether you're a seasoned investor or just getting started, NoirVest provides personalized investment recommendations, market analysis, and portfolio management tools powered by advanced AI agents.
+
+I had the idea to build this because I recently earned some money and was like "I should invest this money", but I am lazy and didn't want to do research so I build this app instead.
+
+## 🚀 Features
+
+- **AI-Powered Investment Analysis**: Get real-time market insights and analysis using advanced AI models
+- **Personalized Portfolio Recommendations**: Receive tailored investment suggestions based on your risk profile and financial goals
+- **Multi-Agent System**: Utilizes specialized AI agents for different aspects of investment management
+- **Interactive Dashboards**: Visualize your portfolio performance and market trends with beautiful, interactive charts
+- **Real-time Market Data**: Stay updated with the latest market information and price movements
+
+## 🛠️ Tech Stack
+
+### Frontend
+- **Next.js 13+** - React framework for building the user interface
+- **TypeScript** - Type-safe JavaScript for better developer experience
+- **Radix UI** - Accessible, unstyled UI components
+- **Tailwind CSS** - Utility-first CSS framework for styling
+- **Chart.js** - Interactive data visualization
+- **Next Themes** - For dark/light mode support
+
+### Backend
+- **Python 3.9+** - Core programming language
+- **FastAPI** - Modern, fast web framework for building APIs
+- **Google Cloud AI** - For advanced AI/ML capabilities
+- **Google Gemini** - AI models for natural language understanding and generation
+- **Google Cloud Services** - For storage, logging, and deployment
+- **Uvicorn** - ASGI server for running FastAPI applications
+
+### Infrastructure
+- **Docker** - Containerization for consistent development and deployment
+- **Google Cloud Platform** - Hosting and cloud services
+- **Firebase** - Authentication and real-time database (if applicable)
+
+## 🏗️ Project Structure
+
+```
+NoirVest/
+├── backend/                  # Backend services
+│   ├── investment_agent/     # AI investment agent implementation
+│   │   ├── agent.py          # Main agent definitions
+│   │   ├── helper_tool.py    # Helper functions and tools
+│   │   └── instructions/     # Agent instructions and prompts
+│   ├── main.py               # FastAPI application entry point
+│   ├── requirements.txt      # Python dependencies
+│   └── Dockerfile            # Container configuration
+│
+├── frontend/                 # Frontend application
+│   ├── components/           # Reusable UI components
+│   ├── pages/                # Next.js pages
+│   ├── public/               # Static assets
+│   ├── styles/               # Global styles
+│   ├── package.json          # Frontend dependencies
+│   └── next.config.js        # Next.js configuration
+│
+└── README.md                 # Project documentation (you are here)
+```
+
+## 🚀 Getting Started
+
+### Prerequisites
+
+- Python 3.9 or higher
+- Node.js 18+ and npm/yarn
+- Google Cloud SDK (for deployment)
+- Docker (optional, for containerized development)
+
+### Local Development
+
+1. **Clone the repository**
+   ```bash
+   git clone https://github.com/yourusername/NoirVest.git
+   cd NoirVest
+   ```
+
+2. **Set up the backend**
+   ```bash
+   cd backend
+   python -m venv venv
+   source venv/bin/activate  # On Windows: .\venv\Scripts\activate
+   pip install -r requirements.txt
+   ```
+
+3. **Set up the frontend**
+   ```bash
+   cd ../frontend
+   npm install
+   ```
+
+4. **Configure environment variables**
+
+   Create `.env` files in both the backend and frontend directories with the required environment variables.
+
+   **Frontend (`.env.local`):**
+   ```env
+   # Firebase Configuration
+   NEXT_PUBLIC_FIREBASE_APP_ID=your_firebase_app_id
+   NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=your_messaging_sender_id
+   NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=your_storage_bucket
+   NEXT_PUBLIC_FIREBASE_PROJECT_ID=your_project_id
+   NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=your_auth_domain
+   NEXT_PUBLIC_FIREBASE_API_KEY=your_firebase_api_key
+   
+   # API Configuration
+   NEXT_PUBLIC_AGENT_API_URL=your_backend_api_url
+   ```
+
+   **Backend (`.env` in the backend directory):**
+   ```env
+   # Google Cloud & AI Configuration
+   GOOGLE_GENAI_USE_VERTEXAI=false
+   GOOGLE_API_KEY=your_google_api_key
+   
+   # Financial Data API
+   FINANCIAL_PREP_API_KEY=your_financial_prep_api_key
+   
+   # Server Configuration
+   PORT=8000
+   DEBUG=true
+   ```
+
+   > **Note**: Replace all placeholder values with your actual configuration. Never commit the actual `.env` files to version control.
+
+5. **Run the development servers**
+   - Backend:
+     ```bash
+     cd backend
+     uvicorn main:app --reload
+     ```
+   - Frontend:
+     ```bash
+     cd frontend
+     npm run dev
+     ```
+
+6. **Access the application**
+   - Frontend: http://localhost:3000
+   - API Docs: http://localhost:8000/docs
+
+## 🤖 AI Agents Overview
+
+NoirVest utilizes a multi-agent system where each agent specializes in a specific aspect of investment management:
+
+1. **Planner Agent**: Develops the overall investment strategy
+2. **Asset Selector**: Identifies promising investment opportunities
+3. **Market Analyzer**: Analyzes market conditions and trends
+4. **Portfolio Recommender**: Suggests optimal portfolio allocations
+5. **Explainer Agent**: Provides clear explanations of investment concepts
+6. **Graph Generator**: Creates visual representations of data and trends
+
+## 🌟 Why NoirVest?
+
+- **Democratizing Investment**: Makes sophisticated investment strategies accessible to everyone
+- **Data-Driven Decisions**: Leverages real-time market data and AI analysis
+- **Transparent**: Clear explanations for all recommendations
+- **Customizable**: Adapts to your unique financial situation and goals
+- **Secure**: Built with security best practices in mind
+
+## 📄 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## 🙏 Acknowledgments
+
+- Built with ❤️ using cutting-edge AI and web technologies
+- Special thanks to the open-source community for their invaluable contributions
+
+## 🤝 Contributing
+
+Contributions are welcome! Please read our [contributing guidelines](CONTRIBUTING.md) to get started.
+
+## 📧 Contact
+
+For any inquiries or support, please contact [[email protected]](mailto:[email protected]).
+
+---
+
+<div align="center">
+  Made with 💙 by Sparsh Jain
+</div>

README.md

@@ -0,0 +1,44 @@
+FROM python:3.13-alpine AS builder
+
+# Install build dependencies only in builder
+RUN apk add --no-cache \
+    build-base \
+    libffi-dev \
+    musl-dev \
+    gcc \
+    python3-dev \
+    linux-headers
+
+WORKDIR /app
+
+COPY requirements.txt .
+
+# Install dependencies in a virtual environment
+RUN python -m venv /opt/venv && \
+    /opt/venv/bin/pip install --no-cache-dir --upgrade pip && \
+    /opt/venv/bin/pip install --no-cache-dir -r requirements.txt
+
+# ---- Final image ----
+FROM python:3.13-alpine
+
+# Install runtime dependencies only (no build tools)
+RUN apk add --no-cache libffi
+
+# Create user
+RUN adduser -D myuser
+
+WORKDIR /app
+
+COPY --from=builder /opt/venv /opt/venv
+COPY . .
+
+# Set permissions
+RUN chown -R myuser:myuser /app
+
+USER myuser
+
+ENV PATH="/opt/venv/bin:$PATH"
+
+EXPOSE 8000
+
+CMD ["uvicorn", "main:app", "--host", "0.0.0.0", "--port", "8000"]

backend/Dockerfile

@@ -0,0 +1,4 @@
+GOOGLE_GENAI_USE_VERTEXAI=FALSE
+GOOGLE_API_KEY=YOUR_GOOGLE_API_KEY
+
+FINANCIAL_PREP_API_KEY=YOUR_FINANCIAL_PREP_API_KEY

backend/investment_agent/.env.example

@@ -1,4 +1,15 @@
+import os
+from typing import Dict, List, Union
 import requests
+from dotenv import load_dotenv
+
+# Load environment variables from .env file
+load_dotenv()
+
+# Get API key from environment variables
+FINANCIAL_PREP_API_KEY = os.getenv('FINANCIAL_PREP_API_KEY')
+if not FINANCIAL_PREP_API_KEY:
+    raise ValueError("FINANCIAL_PREP_API_KEY not found in environment variables")
 
 def get_stock_sentiment(ticker: str) -> dict:
     """
@@ -34,8 +45,7 @@ def get_stock_sentiment(ticker: str) -> dict:
         }
     """
 
-    api_key = "WVfrB6TsRBPL0Xq3ejhdfEpTWLlfT7iN"
-    url = f"https://financialmodelingprep.com/stable/grades-consensus?symbol={ticker}&apikey={api_key}"
+    url = f"https://financialmodelingprep.com/stable/grades-consensus?symbol={ticker}&apikey={FINANCIAL_PREP_API_KEY}"
     try:
         response = requests.get(url)
         response.raise_for_status()  # Raise an exception for bad status codes
@@ -49,7 +59,7 @@ def get_stock_sentiment(ticker: str) -> dict:
         return {"error": f"Failed to parse JSON response: {str(e)}"}
 
 
-def get_market_data_for_assets(tickers: list[str]) -> dict:
+def get_market_data_for_assets(tickers: List[str]) -> Dict[str, Dict[str, List[Dict]]]:
     """
     Fetches comprehensive financial data for one or more stock tickers from the Financial Modeling Prep API.
     
@@ -105,8 +115,7 @@ def get_market_data_for_assets(tickers: list[str]) -> dict:
                            "cash-flow-statement", "shares-float", "market-capitalization", "earnings", "enterprise-value", 
                            "quote", "owners-earning", "income-statement-growth", "balance-sheet-statement-growth", 
                            "cash-flow-statement-growth", "financial-scores-growth","analyst-estimates"] 
-    api_key = "WVfrB6TsRBPL0Xq3ejhdfEpTWLlfT7iN"
-
+    api_key = FINANCIAL_PREP_API_KEY
     data = {}
 
     for ticker in tickers: