Cleanup and rename
This commit is contained in:
18
README.md
18
README.md
@@ -5,8 +5,8 @@ Real-time Skopje public transport tracking with Bun, GTFS/GTFS-RT ingestion, par
|
||||
## What Is In This Repo
|
||||
|
||||
- `bus-tracker-json.ts`: terminal tracker for one stop + one route.
|
||||
- `background-tracker.ts`: continuous collector for multiple routes/stops.
|
||||
- `lib/database.ts`: parquet write layer with rolling segments and optional S3 upload.
|
||||
- `index.ts`: continuous collector for multiple routes/stops.
|
||||
- `lib/storage.ts`: parquet write layer with rolling segments and optional S3 upload.
|
||||
- `lib/gtfs.ts`: GTFS CSV loading helpers.
|
||||
- `config.ts`: API base URL, defaults, and tracker timing.
|
||||
|
||||
@@ -25,19 +25,19 @@ bun run typecheck
|
||||
Run single stop/route terminal tracker:
|
||||
|
||||
```bash
|
||||
bun run tracker
|
||||
bun run bus-tracker-json.ts
|
||||
```
|
||||
|
||||
Run with custom stop and route IDs:
|
||||
|
||||
```bash
|
||||
bun run tracker -- --stop 1571 --route 125
|
||||
bun run bus-tracker-json.ts --stop 1571 --route 125
|
||||
```
|
||||
|
||||
Run background collection pipeline:
|
||||
|
||||
```bash
|
||||
bun run track
|
||||
bun run start
|
||||
```
|
||||
|
||||
## Environment
|
||||
@@ -58,13 +58,11 @@ Key variables:
|
||||
|
||||
## Scripts
|
||||
|
||||
- `bun run start`: alias for the terminal tracker.
|
||||
- `bun run tracker`: terminal tracker.
|
||||
- `bun run track`: background collector.
|
||||
- `bun run start`: collector entrypoint (`index.ts`).
|
||||
- `bun run typecheck`: TypeScript no-emit check.
|
||||
|
||||
## Notes
|
||||
|
||||
- Generated parquet files are intentionally ignored by git (`data/*.parquet`).
|
||||
- The background tracker rotates segments and uploads each closed segment when S3 is enabled.
|
||||
- Generated parquet files are intentionally ignored by git (`data/**/*.parquet`).
|
||||
- The collector rotates segments and uploads each closed segment when S3 is enabled.
|
||||
- On process shutdown (`SIGINT`/`SIGTERM`), writers are flushed so the current segment is finalized.
|
||||
|
||||
Reference in New Issue
Block a user