https://github.com/goww7/halal-portfolio-tracker
Open-source Shariah-compliance tracker for stock portfolios. Next.js 14, one-click Vercel deploy. Powered by Halal Terminal API.
https://github.com/goww7/halal-portfolio-tracker
halal halalterminal islamic-finance nextjs portfolio-tracker shariah stocks vercel
Last synced: about 1 month ago
JSON representation
Open-source Shariah-compliance tracker for stock portfolios. Next.js 14, one-click Vercel deploy. Powered by Halal Terminal API.
- Host: GitHub
- URL: https://github.com/goww7/halal-portfolio-tracker
- Owner: goww7
- License: mit
- Created: 2026-05-07T16:31:46.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2026-05-07T18:15:00.000Z (about 2 months ago)
- Last Synced: 2026-05-07T19:14:33.112Z (about 2 months ago)
- Topics: halal, halalterminal, islamic-finance, nextjs, portfolio-tracker, shariah, stocks, vercel
- Language: TypeScript
- Homepage: https://halal-portfolio-tracker.vercel.app
- Size: 239 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Halal Portfolio Tracker
Open-source Shariah-compliance tracker for your stock portfolio.
---
Enter your stock holdings → get per-stock Shariah compliance, portfolio-level halal %, and purification owed. No signup, no tracking, MIT-licensed.
## Features
- **Per-holding badges** — ✅ Halal / ❌ Non-compliant / ⚠️ Review, with the methodology used
- **Portfolio summary** — total value, compliant %, and estimated purification owed
- **Live prices** — pulled from the same API call, so values reflect today
- **Self-hostable** — Next.js 14 App Router, deploys to Vercel in 30 seconds
- **No database, no auth** — your portfolio never leaves your browser session
---
## One-click deploy
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fgoww7%2Fhalal-portfolio-tracker&env=HALAL_TERMINAL_API_KEY&envDescription=Free%20key%20at%20halalterminal.com&envLink=https%3A%2F%2Fhalalterminal.com)
You'll be prompted for `HALAL_TERMINAL_API_KEY` — grab a [free key here](https://halalterminal.com) (50 requests/month, no credit card).
---
## Run locally
```bash
git clone https://github.com/goww7/halal-portfolio-tracker.git
cd halal-portfolio-tracker
npm install
cp .env.example .env.local
# add HALAL_TERMINAL_API_KEY=ht_...
npm run dev
```
Open [http://localhost:3000](http://localhost:3000).
---
## How it works
1. The browser posts your holdings to `/api/scan`.
2. The route handler calls Halal Terminal's `/api/portfolio/scan` and `/api/quotes/batch` in parallel.
3. We compute compliant %, total value, and purification owed from the merged response.
The API key stays on the server — it is never exposed to the browser.
---
## Configuration
| Env var | Required | Description |
|---|---|---|
| `HALAL_TERMINAL_API_KEY` | yes | Free key at [halalterminal.com](https://halalterminal.com) |
| `HALAL_API_BASE` | no | Override the API base URL (default: `https://api.halalterminal.com`) |
---
## Customizing
- **Branding** — edit `app/layout.tsx` and `app/page.tsx`
- **Methodology display** — adjust `components/ResultsTable.tsx`
- **Fields shown** — extend `lib/halal.ts` with additional endpoints (zakat, news, ETF screening) — see the [API docs](https://halalterminal.com)
---
## Disclaimer
Automated screening output, **not a fatwa**. Consult a qualified scholar for personal rulings. The purification estimate uses the methodology returned by the API and is provided as a starting point.
---
## Related projects
Other open-source tools in the Halal Terminal ecosystem:
| Project | What it is |
|---|---|
| [**halal-discord-bot**](https://github.com/goww7/halal-discord-bot) | Discord bot — `/halal`, `/portfolio`, `/trending` slash commands |
| [**halal-pine**](https://github.com/goww7/halal-pine) | TradingView Pine v5 indicator with daily-refreshed compliance data |
| [**halalterminal-claude-skills**](https://github.com/goww7/halalterminal-claude-skills) | Claude Code plugin with screening skills + portfolio-builder subagent |
| [**halalterminal-mcp**](https://github.com/goww7/halalterminal-mcp) | MCP server for any MCP-compatible client (Cursor, Cline, Codex…) |
| [**yassir-oss**](https://github.com/goww7/yassir-oss) | Open-source ReAct agent for financial research |
---
## License
MIT — see [LICENSE](LICENSE).
Built on top of Halal Terminal.