Skip to content

Commit f25b04d

Browse files
garotmgarotm
committed
garotm - change color scheme.
1 parent 712a11c commit f25b04d

5 files changed

Lines changed: 92 additions & 87 deletions

File tree

‎docs/DEVELOPMENT.md‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -4,29 +4,29 @@ How to work on Sift day to day: scripts, processes, ports, and debugging.
44

55
## The `sift` CLI
66

7-
`sift.mjs` is the single entry point for all day-to-day operations. Run it
7+
`sift.mjs` is the single entry point for all day-to-day operations. Run it
88
with `node sift.mjs <command>` or use the npm shortcuts below.
99

10-
| Command / npm alias | What it does |
11-
| ------------------------------------------ | --------------------------------------------------------------------------------- |
12-
| `node sift.mjs run` / `npm start` | Pre-flight check, then starts backend + frontend + Tauri together. |
13-
| `node sift.mjs debug` / `npm run debug` | Same as `run` with `DEBUG=sift:*` and `RUST_LOG=debug`. |
14-
| `node sift.mjs check` / `npm run check` | Verify Node, Rust, npm deps, Ollama, and model — without starting anything. |
15-
| `node sift.mjs deps` / `npm run deps` | `npm install` in root, frontend, and backend. |
16-
| `node sift.mjs stop` / `npm run stop` | Kill processes on ports 4000 and 1420. |
17-
| `node sift.mjs help` | Full CLI reference. |
10+
| Command / npm alias | What it does |
11+
| --------------------------------------- | --------------------------------------------------------------------------- |
12+
| `node sift.mjs run` / `npm start` | Pre-flight check, then starts backend + frontend + Tauri together. |
13+
| `node sift.mjs debug` / `npm run debug` | Same as `run` with `DEBUG=sift:*` and `RUST_LOG=debug`. |
14+
| `node sift.mjs check` / `npm run check` | Verify Node, Rust, npm deps, Ollama, and model — without starting anything. |
15+
| `node sift.mjs deps` / `npm run deps` | `npm install` in root, frontend, and backend. |
16+
| `node sift.mjs stop` / `npm run stop` | Kill processes on ports 4000 and 1420. |
17+
| `node sift.mjs help` | Full CLI reference. |
1818

1919
## Other top-level scripts
2020

21-
| Script | What it does |
22-
| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
23-
| `npm run dev` | Runs backend, frontend, and Tauri together via `concurrently` (no pre-flight check — use `run` for daily work). |
24-
| `npm run build` | Builds frontend (`vite build`), compiles backend TypeScript (`tsc`), then runs **`cross-env CI=false npx tauri build`** for a release bundle. |
25-
| `npm run tauri` | Pass-through to `@tauri-apps/cli` (for example `npm run tauri -- --help`). |
26-
| `npm run lint:backend` | `tsc --noEmit` in `backend/`. |
27-
| `npm test` | Backend Jest + frontend Vitest. |
28-
| `npm run test:backend` | Jest only (`backend/`). |
29-
| `npm run test:frontend`| Vitest only (`frontend/`). |
21+
| Script | What it does |
22+
| ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
23+
| `npm run dev` | Runs backend, frontend, and Tauri together via `concurrently` (no pre-flight check — use `run` for daily work). |
24+
| `npm run build` | Builds frontend (`vite build`), compiles backend TypeScript (`tsc`), then runs **`cross-env CI=false npx tauri build`** for a release bundle. |
25+
| `npm run tauri` | Pass-through to `@tauri-apps/cli` (for example `npm run tauri -- --help`). |
26+
| `npm run lint:backend` | `tsc --noEmit` in `backend/`. |
27+
| `npm test` | Backend Jest + frontend Vitest. |
28+
| `npm run test:backend` | Jest only (`backend/`). |
29+
| `npm run test:frontend` | Vitest only (`frontend/`). |
3030

3131
## Package-local scripts
3232

@@ -51,10 +51,10 @@ with `node sift.mjs <command>` or use the npm shortcuts below.
5151

5252
## Processes and ports
5353

54-
| Service | Default bind | Purpose |
55-
| ----------------- | ---------------- | ------------------------------------------------ |
56-
| Node orchestrator | `127.0.0.1:4000` | REST API, SQLite, ingest |
57-
| Vite (dev) | `localhost:1420` | UI for `tauri dev` |
54+
| Service | Default bind | Purpose |
55+
| ----------------- | ---------------- | ------------------------------------------------------------ |
56+
| Node orchestrator | `127.0.0.1:4000` | REST API, SQLite, ingest |
57+
| Vite (dev) | `localhost:1420` | UI for `tauri dev` |
5858
| LLM (optional) | user-defined | OpenAI-compatible server; default `127.0.0.1:11434` (Ollama) |
5959

6060
Set `PORT` to change the backend port (see [Configuration](CONFIGURATION.md)).

‎docs/README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,5 @@ Welcome to the documentation for **Sift**, a local-first clinical intelligence d
2727
## Repository root
2828

2929
The top-level [README](../README.md) stays a short overview; deeper detail lives in this folder.
30+
31+
![Sift](../img/sift-app.png)

0 commit comments

Comments
 (0)