Add Docker workflow for publishing image and system setup

Author: charlesvien

.github/workflows/docker-publish.yml

@@ -0,0 +1,49 @@
+name: Docker
+
+on:
+  push:
+    branches: [ "main" ]
+    tags: [ 'v*.*.*' ]
+  pull_request:
+    branches: [ "main" ]
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@v3
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+          tags: |
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }} 

README.md

@@ -32,7 +32,6 @@ By using this software, you agree to use it solely for learning purposes.
 - [Usage](#usage)
   - [Running the Hedge Fund](#running-the-hedge-fund)
   - [Running the Backtester](#running-the-backtester)
-- [Docker](#docker)
 - [Project Structure](#project-structure)
 - [Contributing](#contributing)
 - [License](#license)
@@ -45,6 +44,17 @@ git clone https://github.com/virattt/ai-hedge-fund.git
 cd ai-hedge-fund
 ```
 
+### System Requirements
+- CPU: Any modern CPU (last 5 years)
+- RAM: 2GB minimum, 4GB recommended
+- Storage: 1GB free space
+- Internet: Stable connection required
+- No GPU required
+
+The system is lightweight as it primarily manages workflows between APIs (OpenAI and financial data) without running any local AI models.
+
+### Option 1: Local Setup
+
 1. Install Poetry (if not already installed):
 ```bash
 curl -sSL https://install.python-poetry.org | python3 -
@@ -64,6 +74,28 @@ export OPENAI_API_KEY='your-api-key-here' # Get a key from https://platform.open
 export FINANCIAL_DATASETS_API_KEY='your-api-key-here' # Get a key from https://financialdatasets.ai/
 ```
 
+### Option 2: Docker Setup
+
+You can either build the image locally or use our official image from GitHub Container Registry:
+
+#### Using the Official Image
+
+1. Create and configure your `.env` file as explained above.
+
+2. Pull and run the official image using docker compose:
+```bash
+# Run the trading agent
+docker compose run agent --ticker AAPL
+
+# Run the backtester
+docker compose run backtester --ticker AAPL
+
+# Run with custom parameters
+docker compose run agent --ticker AAPL --start-date 2024-01-01 --end-date 2024-03-01 --show-reasoning
+```
+
+The Docker setup uses a lightweight Python 3.9 base image and installs only the required dependencies.
+
 ## Usage
 
 ### Running the Hedge Fund
@@ -109,26 +141,6 @@ You can optionally specify the start and end dates to backtest over a specific t
 poetry run python src/backtester.py --ticker AAPL --start-date 2024-01-01 --end-date 2024-03-01
 ```
 
-## Docker
-
-You can run the project easily using Docker Compose.
-
-1. Run the agent with custom parameters:
-```bash
-docker compose run agent --ticker AAPL
-```
-
-2. Run the backtester with custom parameters:
-```bash
-docker compose run backtester --ticker AAPL
-```
-
-Note: 
-- The `.env` file will be automatically loaded by Docker Compose
-- Use `docker-compose up` to run with default parameters defined in docker-compose.yml
-- Use `docker-compose run` to pass custom parameters - no need to specify the python command
-- All arguments after the service name are passed directly to the script
-
 ## Project Structure
 ```
 ai-hedge-fund/

docker-compose.yml

@@ -2,9 +2,7 @@ version: '3.8'
 
 services:
   agent:
-    build:
-      context: .
-      dockerfile: Dockerfile
+    image: ghcr.io/virattt/ai-hedge-fund:main
     env_file: .env
     volumes:
       - .:/app
@@ -14,9 +12,7 @@ services:
       - ai-hedge-fund
 
   backtester:
-    build:
-      context: .
-      dockerfile: Dockerfile
+    image: ghcr.io/virattt/ai-hedge-fund:main
     env_file: .env
     volumes:
       - .:/app