An open API service indexing awesome lists of open source software.

https://github.com/fleveque/quantic

Elixir/Phoenix app. AI-enhanced dividend investing. Track your portfolio, set target prices on your radar, plan purchases, and get intelligent insights — all in one place.
https://github.com/fleveque/quantic

dividends elixir finance fintech home-finances investing liveview phoenix

Last synced: 1 day ago
JSON representation

Elixir/Phoenix app. AI-enhanced dividend investing. Track your portfolio, set target prices on your radar, plan purchases, and get intelligent insights — all in one place.

Awesome Lists containing this project

README

          

# Quantic

[![CI](https://github.com/fleveque/quantic/actions/workflows/ci.yml/badge.svg)](https://github.com/fleveque/quantic/actions/workflows/ci.yml)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)

AI-enhanced dividend investing. Track your portfolio, set target prices on your radar, plan purchases, and get intelligent insights — all in one place.

Built on Elixir + Phoenix LiveView. Consolidates a previous multi-stack ecosystem (Rails dividend-portfolio, Phoenix pulse, Go logo-service, NestJS trends) into a single monolith.

## Features

- **Portfolio** — holdings with live prices and multi-currency valuation (yield-on-cost + current yield).
- **Radar** — a watchlist with per-stock buy/sell target prices.
- **Buy plan** — ranks holdings and radar stocks by a composite interest score (including dividend-growth), with tunable per-factor weights, a per-stock "why this rank" breakdown, and one-click checkout into holdings.
- **Dividends** — a cash ledger with IBKR / MyInvestor statement import, per-currency charts (12-month + full-history), a payment calendar, and upcoming ex-dividend tracking.
- **Export your data** — download holdings, dividends, and radar as CSV (Excel/Sheets-ready, UTF-8 BOM), or the whole portfolio as a versioned JSON backup, from **Settings → Your data**. No lock-in.
- **Path to Freedom** — a FIRE projection (three capital pools, inflation, adaptive drawdown) with live sensitivity levers.
- **Community** — opt-in public portfolio (`/p/:slug`) and radar (`/r/:slug`) pages with share images, plus a `/community` dashboard and trending.
- **Ask Quantic (AI chat)** — an always-present assistant on every page. Ask in plain language about your portfolio, radar, dividends, or any stock; answers show the referenced stocks' logos, and the conversation follows you as you navigate. Informational only — not financial advice.
- **AI insights** — portfolio/radar insights and per-stock dividend summaries (yield, payout sustainability, valuation, 52-week position) — observations, strengths, and risks, never buy/sell calls. Gemini, provider-agnostic, with a per-user daily quota.
- **Telegram** — an account-linked bot (queries + a daily digest of ex-divs, dividends, and target hits).
- **Seven languages** — en, es, ca, pt, de, fr, it.
- **Demo mode** — "Try a sample portfolio" seeds a real, ephemeral account so every feature is visible without signing up.

## Quickstart

Requirements: [mise](https://mise.jdx.dev) or [asdf](https://asdf-vm.com) for runtime versions, Docker, and a Postgres-capable shell (`psql`).

```bash
# 1. Install Elixir + Erlang + Node from .tool-versions
# With mise:
mise install
# Or with asdf:
asdf plugin add erlang
asdf plugin add elixir
asdf plugin add nodejs
asdf install

# 2. Start Postgres
docker compose up -d

# 3. Install dependencies and set up the database
mix setup

# 4. (Optional) Configure integrations
cp .env.example .env
# - GOOGLE_OAUTH_CLIENT_ID / _SECRET → enable Google sign-in
# - GEMINI_API_KEY → enable AI insights/summaries
# (all optional in dev; magic-link emails land in the local mailbox)

# 5. Start the server
mix phx.server
```

Open . Magic-link sign-in works out of the box in dev — the email shows up at .

## Project structure

```
lib/
quantic/ # contexts (bounded contexts a la DDD/hex)
accounts/ # users, sessions, OAuth, magic links
... # portfolio, radar, market_data, community,
... # events, logos, ai, content, demo
quantic_web/ # web layer
controllers/ # JSON / OAuth callbacks
live/ # LiveViews (the main UI)
components/ # function components, layouts
user_auth.ex # session + on_mount auth helpers
config/ # compile-time and runtime config
priv/repo/migrations/ # Ecto migrations
docs/ # architecture and per-feature design docs
```

See [`docs/architecture.md`](docs/architecture.md) for the high-level design, bounded contexts, and decisions behind the stack choice.

## Common tasks

| Task | Command |
|---|---|
| Run the dev server | `mix phx.server` |
| Run all tests | `mix test` |
| Format code | `mix format` |
| Pre-commit check (warnings, unused deps, format, test) | `mix precommit` |
| Create + migrate DB | `mix ecto.setup` |
| Reset DB | `mix ecto.reset` |
| Start an IEx session with the app | `iex -S mix phx.server` |

## Translations

Quantic speaks English, Español, Català, Português, Deutsch, Français and Italiano. Translations are community-improvable — they live in plain `.po` files under `priv/gettext//LC_MESSAGES/`:

- **Fix a translation**: edit the `msgstr` in that locale's `default.po` (UI strings) or `faq.po` (FAQ content) and open a PR. No Elixir knowledge needed.
- **Add a language**: add the locale code to `@supported` and `native_names/0` in `lib/quantic_web/locale.ex`, run `mix gettext.merge priv/gettext --locale `, fill the generated `.po` files, PR. Untranslated strings fall back to English, so partial translations ship fine.

## License

MIT — see [LICENSE](LICENSE).