OpenStock README

The project's README from github.com/Open-Dev-Society/OpenStock. As one markdown file: README.md.

Open-Dev-Society%2FOpenStock | Trendshift Open-Dev-Society%2FOpenStock | Trendshift Open-Dev-Society%2FOpenStock | Trendshift

Open-Dev-Society%2FOpenStock | Trendshift Star History Rank


Project Banner © Open Dev Society. This project is licensed under AGPL-3.0; if you modify, redistribute, or deploy it (including as a web service), you must release your source code under the same license and credit the original authors.

Next.js badge

OpenStock

OpenStock is an open-source alternative to expensive market platforms. Track real-time prices, set personalized alerts, and explore detailed company insights — built openly, for everyone, forever free.

Note: OpenStock is community-built and not a brokerage. Market data may be delayed based on provider rules and your configuration. Nothing here is financial advice.

📋 Table of Contents

  1. ✨ Introduction
  2. 🌍 Open Dev Society Manifesto
  3. ⚙️ Tech Stack
  4. 🔋 Features
  5. 🤸 Quick Start
  6. 🐳 Docker Setup
  7. 🔐 Environment Variables
  8. 🧱 Project Structure
  9. 📡 Data & Integrations
  10. 🌍 Market Support
  11. 🧪 Scripts & Tooling
  12. 🤝 Contributing
  13. 🛡️ Security
  14. 📜 License
  15. 🙏 Acknowledgements

✨ Introduction

OpenStock is a modern stock market app powered by Next.js (App Router), shadcn/ui and Tailwind CSS, Better Auth for authentication, MongoDB for persistence, Finnhub for market data, and TradingView widgets for charts and market views.

🌍 Open Dev Society Manifesto

We live in a world where knowledge is hidden behind paywalls. Where tools are locked in subscriptions. Where information is twisted by bias. Where newcomers are told they’re not “good enough” to build.

We believe there’s a better way.

Because the future belongs to those who build it openly.

⚙️ Tech Stack

Core

Auth & Data

Automation & Comms

Language composition

🔋 Features

🤸 Quick Start

Prerequisites

Clone and install

git clone https://github.com/Open-Dev-Society/OpenStock.git
cd OpenStock

# choose one:
pnpm install
# or
npm install

Configure environment

pnpm test:db
# or
npm run test:db

Run development

# Next.js dev (Turbopack)
pnpm dev
# or
npm run dev

Run Inngest locally (workflows, cron, AI)

npx inngest-cli@latest dev

Build & start (production)

pnpm build && pnpm start
# or
npm run build && npm start

Open http://localhost:3000 to view the app.

🐳 Docker Setup

You can run OpenStock and MongoDB easily with Docker Compose.

  1. Ensure Docker and Docker Compose are installed.

  2. docker-compose.yml includes two services:

  1. Create your .env (see examples below). For the Docker setup, use a local connection string like:
MONGODB_URI=mongodb://root:example@mongodb:27017/openstock?authSource=admin
  1. Start the stack:
# from the repository root
docker compose up -d mongodb && docker compose up -d --build
  1. Access the app:

Notes

Optional: Example MongoDB service definition used in this project:

services:
  mongodb:
    image: mongo:7
    container_name: mongodb
    restart: unless-stopped
    environment:
      MONGO_INITDB_ROOT_USERNAME: root
      MONGO_INITDB_ROOT_PASSWORD: example
    ports:
      - "27017:27017"
    volumes:
      - mongo-data:/data/db
    healthcheck:
      test: ["CMD", "mongosh", "--eval", "db.adminCommand('ping')"]
      interval: 10s
      timeout: 5s
      retries: 5

volumes:
  mongo-data:

🔐 Environment Variables

Create .env at the project root. Choose either a hosted MongoDB (Atlas) URI or the local Docker URI.

Hosted (MongoDB Atlas):

# Core
NODE_ENV=development

# Database (Atlas)
MONGODB_URI=mongodb+srv://<user>:<pass>@<cluster>/<db>?retryWrites=true&w=majority

# Better Auth
BETTER_AUTH_SECRET=your_better_auth_secret
BETTER_AUTH_URL=http://localhost:3000

# Finnhub
# Note: NEXT_PUBLIC_FINNHUB_API_KEY is required for Vercel deployment
NEXT_PUBLIC_FINNHUB_API_KEY=your_finnhub_key
FINNHUB_BASE_URL=https://finnhub.io/api/v1

# Sentiment insights (optional)
ADANOS_API_KEY=your_adanos_api_key
# ADANOS_API_BASE_URL=https://api.adanos.org

# AI Provider (optional, default: "gemini")
# Supported: "gemini", "minimax", "siray"
# AI_PROVIDER=gemini

# Gemini
GEMINI_API_KEY=your_gemini_api_key

# MiniMax (optional, used when AI_PROVIDER=minimax or as fallback)
# Get your key at https://platform.minimaxi.com
# MINIMAX_API_KEY=your_minimax_api_key

# Inngest Signing Key (required for Vercel deployment)
# Get this from your Inngest dashboard: https://app.inngest.com/env/settings/keys
INNGEST_SIGNING_KEY=your_inngest_signing_key

# Email (Nodemailer via Gmail; consider App Passwords if 2FA)
[email protected]
NODEMAILER_PASSWORD=your_gmail_app_password

Local (Docker Compose) MongoDB:

# Core
NODE_ENV=development

# Database (Docker)
MONGODB_URI=mongodb://root:example@mongodb:27017/openstock?authSource=admin

# Better Auth
BETTER_AUTH_SECRET=your_better_auth_secret
BETTER_AUTH_URL=http://localhost:3000

# Finnhub
# Note: NEXT_PUBLIC_FINNHUB_API_KEY is required for Vercel deployment
NEXT_PUBLIC_FINNHUB_API_KEY=your_finnhub_key
FINNHUB_BASE_URL=https://finnhub.io/api/v1

# Sentiment insights (optional)
ADANOS_API_KEY=your_adanos_api_key
# ADANOS_API_BASE_URL=https://api.adanos.org

# AI Provider (optional, default: "gemini")
# Supported: "gemini", "minimax", "siray"
# AI_PROVIDER=gemini

# Gemini
GEMINI_API_KEY=your_gemini_api_key

# MiniMax (optional, used when AI_PROVIDER=minimax or as fallback)
# Get your key at https://platform.minimaxi.com
# MINIMAX_API_KEY=your_minimax_api_key

# Inngest Signing Key (required for Vercel deployment)
# Get this from your Inngest dashboard: https://app.inngest.com/env/settings/keys
INNGEST_SIGNING_KEY=your_inngest_signing_key

# Email (Nodemailer via Gmail; consider App Passwords if 2FA)
[email protected]
NODEMAILER_PASSWORD=your_gmail_app_password

Notes

🧱 Project Structure 

app/
  (auth)/
    layout.tsx
    sign-in/page.tsx
    sign-up/page.tsx
  (root)/
    layout.tsx
    page.tsx
    help/page.tsx
    stocks/[symbol]/page.tsx
  api/inngest/route.ts
  globals.css
  layout.tsx
components/
  ui/…          # shadcn/radix primitives (button, dialog, command, input, etc.)
  forms/…       # InputField, SelectField, CountrySelectField, FooterLink
  Header.tsx, Footer.tsx, SearchCommand.tsx, WatchlistButton.tsx, …
database/
  models/watchlist.model.ts
  mongoose.ts
lib/
  actions/…     # server actions (auth, finnhub, user, watchlist)
  better-auth/…
  inngest/…     # client, functions, prompts
  nodemailer/…  # transporter, email templates
  constants.ts, utils.ts
scripts/
  test-db.mjs
types/
  global.d.ts
next.config.ts          # i.ibb.co image domain allowlist
postcss.config.mjs      # Tailwind v4 postcss setup
components.json         # shadcn config
public/assets/images/   # logos and screenshots

📡 Data & Integrations

🌍 Market Support

OpenStock supports 30+ international stock exchanges including NSE, LSE, TSX, and more. However, please be aware of important limitations based on our data providers.

Quick Facts:

See MARKET_SUPPORT.md for:

For the latest supported symbols and exchanges, see Finnhub's exchange list.

🧪 Scripts & Tooling

Package scripts

Developer experience

🤝 Contributing

You belong here. Whether you’re a student, a self-taught dev, or a seasoned engineer — contributions are welcome.

🛡️ Security

If you discover a vulnerability:

📜 License

OpenStock is and will remain free and open for everyone. This project is licensed under the AGPL-3.0 License - see the LICENSE file for details.

🙏 Acknowledgements

— Built openly, for everyone, forever free. Open Dev Society.

© Open Dev Society. This project is licensed under AGPL-3.0; if you modify, redistribute, or deploy it (including as a web service), you must release your source code under the same license and credit the original authors.

Our Honourable Contributors

❤️ Partners & Backers

Siray.ai Logo

Siray.ai — The robust AI infrastructure backing OpenStock. Siray.ai ensures our market insights never sleep.

Special thanks

Huge thanks to Adrian Hajdin (JavaScript Mastery) — his excellent Stock Market App tutorial was instrumental in building OpenStock for the open-source community under the Open Dev Society.

GitHub: adrianhajdin YouTube tutorial: Stock Market App Tutorial YouTube channel: JavaScript Mastery

OpenStock (Open-Dev-Society/OpenStock)

sentiment-analysis
Searching Database…

20.3K ·GitHub
OpenStock
What is this?OpenStock is an open-source, self-hosted stock market tracking app: track real-time prices, set personalized alerts, and explore company insights as a free alternative to paid market platforms.
Is this a hosted service or something I run myself?It's a self-hosted web app you deploy yourself, built with Next.js (App Router), shadcn/ui, and MongoDB, with TradingView widgets for charts and market views. There's no managed hosted version — it's community-built and not a brokerage.
How do I get it running?Clone the repo, create a .env file with your API keys, then run the Next.js dev server with pnpm/npm, or spin up the whole stack (app + MongoDB) with Docker Compose using docker-compose up.
What do I need before I can run it?Node.js 20+, a MongoDB connection (Atlas or local via Docker), a Finnhub API key for market data, and a Gmail account for sending emails; a Google Gemini API key is optional for AI-personalized welcome emails.
Do I get real-time data for every market?No — Finnhub and TradingView free tiers have limits: real-time data for non-US stocks is delayed by 15+ minutes, and some emerging markets (India NSE, Vietnam, etc.) have TradingView restrictions.
What's the catch with the AGPL-3.0 license?If you modify, redistribute, or deploy OpenStock (including as a web service), you must release your source code under the same AGPL-3.0 license and credit the original authors.
What stock exchanges does it support?Over 30 international exchanges via Finnhub, including NSE, LSE, and TSX, though free-tier restrictions apply to some emerging markets.
What AI features does it have?It uses Google Gemini (triggered through Inngest) to generate AI-personalized welcome emails and daily watchlist-based news summary emails on a cron schedule.
Does it include sentiment analysis?Yes, as an optional feature it shows cross-source sentiment insights from Reddit, X.com, news, and Polymarket on stock detail pages, alongside the core Finnhub/TradingView data.
What happens during onboarding?New users are asked for their country, investment goals, risk tolerance, and preferred industry so the app can personalize emails and recommendations.
What are similar projects?OpenTerminal, rankme.fast, Trpjan-solana-trading-toolkit, trade-journal, daily_stock_analysis, crm, TradingAgents-CN, Zero
Which topics is it in?sentiment-analysis, cron, shadcn-ui, stock-market, charts, mongodb, email, finance, tailwindcss, data-visualization, authentication, nextjs
Creator
Open-Dev-Society
Size
3 MB
Stars
20.3K
Updated
CommitOct 18Releasev2026.10.18Oct 18
Age
1y
Commits · 90 Days