Skip to content

fleveque/quantic

Repository files navigation

Quantic

CI License: MIT

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, with tunable per-factor weights 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.
  • 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.
  • AI — portfolio/radar insights and per-stock summaries (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 or asdf for runtime versions, Docker, and a Postgres-capable shell (psql).

# 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 http://localhost:4000. Magic-link sign-in works out of the box in dev — the email shows up at http://localhost:4000/dev/mailbox.

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 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/<locale>/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 <code>, fill the generated .po files, PR. Untranslated strings fall back to English, so partial translations ship fine.

License

MIT — see LICENSE.

About

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.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors