From 3f05e0f2bf7712864404abfaf6481559344eb67f Mon Sep 17 00:00:00 2001 From: GeorgeWebberley Date: Sun, 1 Mar 2026 14:33:34 +0100 Subject: [PATCH] Fixed env in README and re-added test script --- README.md | 30 +++++++++++++++++++++--------- package.json | 1 + 2 files changed, 22 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 65b4953..542337d 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,8 @@ This is a NestJS-based legal document parsing application built for the Pandekte - **Docker & Docker Compose** - **Node.js (v20+)** - **Gemini API Key** (Get one at [Google AI Studio](https://aistudio.google.com/)) -NOTE: I attached billing to my google account to prevent hitting the free tier limits. + +> **Note:** I attached billing to my Google account to prevent hitting the free tier limits. ### Installation 1. **Clone the Repo**: @@ -27,22 +28,33 @@ NOTE: I attached billing to my google account to prevent hitting the free tier l 2. **Environment Setup**: Create a `.env` file in the root: ```env + # App config + PORT=3000 + NODE_ENV=development + # AI Config GOOGLE_API_KEY=your_gemini_api_key_here - # Database (Standard Docker defaults) + # Database config + POSTGRES_USER=postgres + POSTGRES_PASSWORD=postgres + POSTGRES_DB=pandektes + POSTGRES_PORT=5432 DATABASE_URL="postgresql://postgres:postgres@localhost:5432/pandektes?schema=public" - REDIS_HOST="localhost" + + # Redis config + REDIS_HOST=localhost REDIS_PORT=6379 # Storage (Local Minio) - STORAGE_ENDPOINT="http://localhost:9000" - STORAGE_BUCKET="cases" - STORAGE_REGION="us-east-1" - STORAGE_ACCESS_KEY="minioadmin" - STORAGE_SECRET_KEY="minioadmin" - STORAGE_FORCE_PATH_STYLE="true" + STORAGE_ENDPOINT=http://localhost:9000 + STORAGE_BUCKET=cases + STORAGE_REGION=us-east-1 + STORAGE_ACCESS_KEY=minioadmin + STORAGE_SECRET_KEY=minioadmin + STORAGE_FORCE_PATH_STYLE=true ``` + Or simply copy the example: `cp .env.example .env` and add your `GOOGLE_API_KEY`. 3. **Start Infrastructure**: ```bash docker-compose up -d diff --git a/package.json b/package.json index 2656b8d..f47d0c5 100644 --- a/package.json +++ b/package.json @@ -10,6 +10,7 @@ "start": "nest start", "start:dev": "nest start --watch", "start:prod": "npm run build && nest start", + "test": "jest", "postinstall": "prisma generate" }, "dependencies": {