How algora-io/algora works
Project type and purpose
• This is a full-stack Elixir/Phoenix application (lib/algora + lib/algora_web) with an integrated GitHub App and payment processor.
• Business logic lives in lib/algora (contexts: accounts, activities, bounties, chat, payments, workspace, etc.). The web UI and API are in lib/algora_web (LiveView, controllers, components).
• Static content and docs are in priv/content. Asset building uses Node.js + Svelte + Tailwind (assets/). Background jobs use Oban.
File structure
• Top-level directories:
• assets/ → front-end build (Svelte components, TS, CSS, JS)
• config/ → environment configs for dev/prod/test
• lib/algora/ → core contexts and domain logic
• lib/algora_web/ → Phoenix endpoint, router, controllers, LiveView, components, plugs
• priv/repo/ → Ecto migrations & seeds
• rel/ → release scripts (Distillery or Mix releases)
• test/ → ExUnit tests for contexts, web, integrations
• Key config: Dockerfile, fly.toml, .env.example for external service keys (GitHub, Stripe, S3, Cloudflare Tunnel).
• Background work: Oban jobs in multiple contexts (activities/jobs, bounties/jobs, workspace/jobs, etc.).
README for additional insights
• Describes three “apps” in one codebase: Web app, GitHub App, Payment engine.
• Uses Docker/Postgres in dev, external dependencies: GitHub webhooks & polling, Stripe webhooks, S3 for static assets, Cloudflare Tunnel for local webhooks.
Detail but avoid clutter
• Every major context only if it clarifies data flow (e.g. Accounts, Bounties, Chat can be sub-contexts).
• Core paths: user login, bounty creation, tip sending, job application, webhook handling, payment flow.
• Oban queue with examples of jobs (send_email, notify_discord).
• Call out the Poller supervisor under GitHub integration to show event-driven vs. webhook flows.