Getting Started

Get Richfolio running locally in under 5 minutes.

Prerequisites

Node.js 22+ — Download
npm — comes with Node.js
A GitHub account — for automated scheduling via Actions (optional for local use)

Fork & Install

Recommended: Fork the repo first so you can use GitHub Actions for automated daily briefs, intraday alerts, and weekly reports. Then clone your fork:

git clone https://github.com/YOUR_USERNAME/richfolio.git
cd richfolio
npm install

Configure

Portfolio (`config.json`)

cp config.example.json config.json

Edit config.json with your target allocations and current holdings. See Configuration for the full field reference.

API Keys (`.env`)

cp .env.example .env

Add your API keys. At minimum you need RESEND_API_KEY and RECIPIENT_EMAIL. See API Keys for step-by-step instructions for each service.

Run

# Daily brief — prices + news + AI analysis + email + Telegram
npm run dev

# Intraday alert check — compares vs morning baseline
npm run intraday

# Weekly rebalancing report — prices + allocation drift + email + Telegram
npm run weekly

Check your email and Telegram for the results.

What’s Next

Configuration — customize your portfolio allocations
API Keys — set up Resend, NewsAPI, Gemini, and Telegram
Deployment — automate with GitHub Actions