Back to the catalog

Tooling

Tools used in this repo.

Open source Repository Open in the app JSON README (API)

About

# Tooling

- [liteparse](liteparse.md) — Local PDF parser for ingesting course documents
- [mlx-whisper](mlx-whisper.md) — Local Apple Silicon speech-to-text for transcribing lecture videos
- [Supply Chain Cooldown](supply-chain-cooldown.md) — seven-day package cooldown policy to reduce supply chain attack exposure

Details

Kind
OKF bundles
Topic
AI, RAG & memory
Publisher
aanyam22
Origin
okf_github
Category
dados
Version
0.1
Last push
2026-09-07T22:44:10Z
Repository state
ativo
Language
Jupyter Notebook
Added
2026-09-08 09:04:14
Updated
2026-09-08 09:04:14
Origin id
aanyam22/capstone-market-prediction:apps/data/course_items/lecture-course-tooling/index.md

README

# capstone-498

MSDS 498 capstone project, Summer 2026. Consumer Staples Earnings Intelligence Platform.

> This repo is shared for portfolio/review purposes. It requires hosted infrastructure
> (database, auth, deployed API) to actually run — it isn't a clone-and-run demo. See the
> Screenshots section below for what the working app looks like.

## Screenshots

This is a course capstone project. The app is not hosted anywhere public, so these
fixture-backed screenshots (real Expo UI, committed demo data, not live market data)
are the easiest way to see what it does.

| Sector Pulse | Company Detail |
|---|---|
| ![Sector Pulse](docs/writeups/screenshots/mobile-demo/01-sector-pulse.png) | ![Company Detail](docs/writeups/screenshots/mobile-demo/02-company-detail.png) |

| Earnings Analysis | Rankings |
|---|---|
| ![Earnings Analysis](docs/writeups/screenshots/mobile-demo/03-earnings-analysis.png) | ![Rankings](docs/writeups/screenshots/mobile-demo/04-rankings.png) |

More screenshots, including a UX-audit set and before/after homepage comparisons, are
in [`docs/writeups/screenshots/`](docs/writeups/screenshots/) and
[`screenshots/`](screenshots/).

## Start here if you are new to app development

This repo is meant to become a deployed product, not just a collection of notebooks.
If your background is mostly notebooks and Python scripts, start with
[`docs/developer-onboarding.md`](docs/developer-onboarding.md). It explains the repo
map, local setup, common app-development vocabulary, and the difference between
running something on your laptop and deploying it so a phone or browser can reach it.

The shortest path to being productive:

1. Read this README for the map.
2. Read [`docs/developer-onboarding.md`](docs/developer-onboarding.md) for setup.
3. Read [`docs/design/platform/product-requirements.md`](docs/design/platform/product-requirements.md) for what the team is building.
4. Work in one area at a time: `apps/mobile`, `apps/api`, `apps/inference`,
   `apps/data`, `apps/schema`, or `docs/writeups`.

## Repo layout

| Path | What lives there | First file to read |
|------|------------------|--------------------|
| `apps/inference/` | Inference and EDA workspace for traditional ML and AI workflows. Owner: Adwoa. | [`apps/inference/README.md`](apps/inference/README.md) |
| `apps/mobile/` | Expo and React Native mobile/web frontend. Owner: Eli. | [`apps/mobile/README.md`](apps/mobile/README.md) |
| `apps/api/` | App-facing TypeScript/Hono API, Better Auth, and SQL-backed data routes. Owner: Eli. | [`apps/api/README.md`](apps/api/README.md) |
| `apps/data/` | Data pipeline and dashboard infrastructure. Owner: Jovana. | [`apps/data/README.md`](apps/data/README.md) |
| `apps/schema/` | Shared SQLite/libSQL schema, local reset helper, and database smoke tests. | [`apps/schema/README.md`](apps/schema/README.md) |
| `docs/writeups/` | Written deliverables: project goals, initial findings, final report, presentation. Owner: Ethan. | [`docs/writeups/`](docs/writeups/) |
| `docs/` | Design docs, course materials, team notes. | [`docs/index.md`](docs/index.md) |

See [`docs/design/platform/product-requirements.md`](docs/design/platform/product-requirements.md) for the full PRD.

## Local setup

Setup commands are documented in the app-specific folders once that part of the
project has a confirmed workflow. Start with the README for the area you are working
in:

- [`apps/inference/README.md`](apps/inference/README.md)
- [`apps/mobile/README.md`](apps/mobile/README.md)
- [`apps/api/README.md`](apps/api/README.md)
- [`apps/data/README.md`](apps/data/README.md)
- [`apps/schema/README.md`](apps/schema/README.md)

The inherited scripts in `apps/data/` can download, transcribe, or write files when
run. Read [`apps/data/README.md`](apps/data/README.md) before running one.

`apps/mobile/` and `apps/api/` form the user-facing application. Authentication
always uses the API; business data can use mobile fixtures or the live SQL-backed API.
Their READMEs document the two-terminal local workflow, environment variables,
validation commands, and deployment boundaries.

## Ops tooling

The daily team digest workflow is documented in
[`docs/team/daily-team-digest.md`](docs/team/daily-team-digest.md). That document is
the source of truth for the Gmail OAuth environment variables used by
`scripts/daily_team_digest.py`; do not copy sender, recipient, token, or client-secret
values into this README.

## Course deadlines

See [`docs/course/project-schedule-full.md`](docs/course/project-schedule-full.md).

## Agent guidance

AI coding assistants should read `AGENTS.md` (Codex + Cursor) or `CLAUDE.md` (Claude
Code) at the repo root first, then the nearest scoped `AGENTS.md` for the directory
they are editing.

Both root files are generated from [`.ruler/AGENTS.md`](.ruler/AGENTS.md) — the
single source of truth for agent instructions — via
[Ruler](https://github.com/intellectronica/ruler). To update agent guidance, edit
`.ruler/AGENTS.md` and regenerate:

```sh
npx @intellectronica/ruler apply --no-mcp --no-gitignore
```

Generated files (`AGENTS.md`, `CLAUDE.md`) are committed to git so that worktrees and
fresh clones pick them up automatically without needing Ruler installed. MCP server
configs live in agent-specific files (`.claude/settings.json`, `.codex/config.toml`,
`.cursor/mcp.json`) and are managed manually.

When adding or changing a runnable part of the project, maintain both the relevant
README and `.ruler/AGENTS.md`: README files orient teammates, while agent files orient
coding harnesses that may be helping those teammates.

More