From 253ac63fe98940a55640be5bfc7a9645a926f742 Mon Sep 17 00:00:00 2001 From: Cursor Agent Date: Sun, 21 Dec 2025 19:28:13 +0000 Subject: [PATCH] Refactor: Improve README setup instructions Co-authored-by: mathieumoran1 --- README.md | 24 +++++++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 429591f..9889e5f 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,16 @@ Little nodejs + mongodb app that I hack together with ChatGPT and Cursor to keep - Version endpoint backed by latest GitHub commit (cached) ## Setup -Config those in your .env file: +Create a `.env` file at the project root (same folder as `package.json`). It’s not committed to git—each machine needs its own values. + +Minimal steps: + +```bash +npm install +node index.js +``` + +Configure these in your `.env` file (**required**: `MONGO_URI`, `JWT_SECRET`): **DOG_NAMES=**`woof, WOOF, Woof`     (for "verification")
**GITHUB_OWNER=**`quoije`     (for version history)
@@ -27,6 +36,17 @@ Config those in your .env file: **MONGO_URI=**`mongodb+srv://USER:PASS@cluster0.XXXX.mongodb.net/?retryWrites=true&w=majority&appName=Cluster69`
**OMDB_API=**`1234567`     (for movie info) +Example `.env`: + +```bash +MONGO_URI=mongodb://127.0.0.1:27017/oscars-pool +JWT_SECRET=change-me +DOG_NAMES=woof,WOOF,Woof +OMDB_API=your_omdb_key +GITHUB_OWNER=quoije +GITHUB_REPO=oscars-pool +``` + ## Database (MongoDB) This app uses **MongoDB** via Mongoose. Provide a connection string in `MONGO_URI`. @@ -35,5 +55,3 @@ This app uses **MongoDB** via Mongoose. Provide a connection string in `MONGO_UR - Atlas: `mongodb+srv://USER:PASS@cluster0.XXXX.mongodb.net/?retryWrites=true&w=majority` - Local: `mongodb://127.0.0.1:27017/` - Collections are created/managed automatically from the models in `models/` (e.g. `User`, `Movie`, `Setting`, `PlaybackProgress`). - -run with **node .\index.js**