Get Started with OpenCase

Choose your deployment method and start building custom portfolios in minutes.

Recommended

Cloudflare (Recommended)

Deploy on Cloudflare's edge network for free. Global distribution, automatic scaling, zero maintenance.

  1. 1Fork the OpenCase repository on GitHub
  2. 2Create a Cloudflare account (free)
  3. 3Connect your GitHub repository to Cloudflare Pages
  4. 4Configure environment variables (API keys, encryption key)
  5. 5Deploy with one click
Privacy First

Docker Self-Hosted

Run OpenCase locally or on your own server with Docker. Complete control and privacy.

  1. 1Clone the OpenCase repository
  2. 2Copy .env.example to .env and configure
  3. 3Run docker-compose up -d
  4. 4Access OpenCase at localhost:8787
  5. 5Create your first admin account
For Developers

Local Development

Set up a local development environment to contribute or customize OpenCase.

  1. 1Clone the repository: git clone ...
  2. 2Install dependencies: npm install
  3. 3Copy wrangler.jsonc.example to wrangler.jsonc
  4. 4Run migrations: npm run db:migrate
  5. 5Start dev server: npm run dev

Quick Start Commands

Clone Repository
git clone https://github.com/marketcalls/opencase.git
Install Dependencies
cd opencase && npm install
Apply Database Migrations
npm run db:migrate:local
Seed Template Data
npm run db:seed
Build the Project
npm run build
Start Development Server
npm run dev

Broker API Setup

Z

Zerodha

  1. Create a Kite Connect app at kite.trade
  2. Note your API Key and API Secret
  3. Set redirect URL to your OpenCase instance
  4. Add credentials to environment variables
A

Angel One

  1. Register for Smart API at smartapi.angelone.in
  2. Get your API Key and Client ID
  3. Generate TOTP secret for authentication
  4. Add credentials to environment variables

Configuration (Optional)

OpenCase is zero-config by default. All settings can be optionally customized via the YAML configuration file.

opencase.config.yaml
# Token cleanup settings
tokenCleanup:
enabled: true
time: "03:00"
timezone: "Asia/Kolkata"
# Session settings
session:
expiryDays: 7
# Broker token settings
brokerToken:
tokenExpiryHours: 8

First Steps After Setup

1

Create Admin Account

First user automatically becomes admin

2

Connect Broker

Add your Zerodha or Angel One account

3

Download Instruments

Sync master instrument database

4

Create First Basket

Start with a template or build your own

Ready to Start Investing?

Join the open-source portfolio management revolution. Full control, no fees.

View on GitHubExplore Features