Skip to content

getting-started.md

Latest commit

 

History

History
36 lines (24 loc) · 983 Bytes

getting-started.md

File metadata and controls

36 lines (24 loc) · 983 Bytes
Raw

Getting started

Requirements

  • Node.js 24+ (uses the built-in node:sqlite module)
  • A TMDB API key (optional; enables posters, overviews, and discovery)

Setup

npm install
cp .env.example .env        # add TMDB_API_KEY (or TMDB_READ_TOKEN)

Import your data

Export ratings and watchlist CSVs from IMDb, then drop them into ./exported (or ./data). They're auto-classified by their column headers.

npm run import              # load CSVs into the local database
npm run enrich              # fetch posters + metadata from TMDB (resumable)

The database is created automatically, and CSVs are auto-imported on first boot if the library is empty — so you can skip straight to running the app.

Run

npm run dev                 # http://localhost:5173 (API on :3001)

For a production-style single-port run: npm run serve.

See configuration and importing & exporting.