README.md

metadata

title: Munger Engine
emoji: 🚀
colorFrom: blue
colorTo: green
sdk: docker
pinned: false

Munger Engine

Munger Engine is a specialized stock analysis tool and API designed to replicate and automate value investing strategies (inspired by Charlie Munger). It processes market data, applies fundamental filters, and generates trading signals.

Features

• Automated Analysis: Scans stocks using Yahoo Finance data.
• Value Filters: ROE > 15%, Debt/Equity < 50, and technical checks (WMA200).
• API First: Exposes signals, ticker details, and sync status via a REST API.
• Dockerized: Ready for deployment on Hugging Face Spaces.
• Secure: Protected by API Key authentication.

Documentation

• API Documentation: Endpoints, authentication, and examples.
• Requirements: Functional and technical requirements.
• Postman Collection: Importable collection for testing.

Getting Started

Prerequisites

• Node.js (v22+)
• Docker (optional, for containerized run)

Installation

1. Clone the repository:

   git clone https://github.com/Diego-Romero-NTT/munger-engine.git
   cd munger-engine
   

2. Install dependencies:

   npm install
   

3. Configure Environment: Create a .env file with:

   API_KEY=your_generated_secure_key
   ALPACA_KEY=your_alpaca_key (optional for portfolio check)
   ALPACA_SECRET=your_alpaca_secret (optional)
   NEXT_PUBLIC_SYNC_PASSWORD=Pelikan23!
   

4. Run Development Server:

   npm run dev
   

Deployment

This project is configured for Hugging Face Spaces using Docker.

• Push to Space:

  git push origin main
  

  (Assumes origin is configured to push to both GitHub and HF).

License

MIT