Fixed env in README and re-added test script
This commit is contained in:
parent
fd494bd674
commit
3f05e0f2bf
30
README.md
30
README.md
|
|
@ -16,7 +16,8 @@ This is a NestJS-based legal document parsing application built for the Pandekte
|
||||||
- **Docker & Docker Compose**
|
- **Docker & Docker Compose**
|
||||||
- **Node.js (v20+)**
|
- **Node.js (v20+)**
|
||||||
- **Gemini API Key** (Get one at [Google AI Studio](https://aistudio.google.com/))
|
- **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
|
### Installation
|
||||||
1. **Clone the Repo**:
|
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**:
|
2. **Environment Setup**:
|
||||||
Create a `.env` file in the root:
|
Create a `.env` file in the root:
|
||||||
```env
|
```env
|
||||||
|
# App config
|
||||||
|
PORT=3000
|
||||||
|
NODE_ENV=development
|
||||||
|
|
||||||
# AI Config
|
# AI Config
|
||||||
GOOGLE_API_KEY=your_gemini_api_key_here
|
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"
|
DATABASE_URL="postgresql://postgres:postgres@localhost:5432/pandektes?schema=public"
|
||||||
REDIS_HOST="localhost"
|
|
||||||
|
# Redis config
|
||||||
|
REDIS_HOST=localhost
|
||||||
REDIS_PORT=6379
|
REDIS_PORT=6379
|
||||||
|
|
||||||
# Storage (Local Minio)
|
# Storage (Local Minio)
|
||||||
STORAGE_ENDPOINT="http://localhost:9000"
|
STORAGE_ENDPOINT=http://localhost:9000
|
||||||
STORAGE_BUCKET="cases"
|
STORAGE_BUCKET=cases
|
||||||
STORAGE_REGION="us-east-1"
|
STORAGE_REGION=us-east-1
|
||||||
STORAGE_ACCESS_KEY="minioadmin"
|
STORAGE_ACCESS_KEY=minioadmin
|
||||||
STORAGE_SECRET_KEY="minioadmin"
|
STORAGE_SECRET_KEY=minioadmin
|
||||||
STORAGE_FORCE_PATH_STYLE="true"
|
STORAGE_FORCE_PATH_STYLE=true
|
||||||
```
|
```
|
||||||
|
Or simply copy the example: `cp .env.example .env` and add your `GOOGLE_API_KEY`.
|
||||||
3. **Start Infrastructure**:
|
3. **Start Infrastructure**:
|
||||||
```bash
|
```bash
|
||||||
docker-compose up -d
|
docker-compose up -d
|
||||||
|
|
|
||||||
|
|
@ -10,6 +10,7 @@
|
||||||
"start": "nest start",
|
"start": "nest start",
|
||||||
"start:dev": "nest start --watch",
|
"start:dev": "nest start --watch",
|
||||||
"start:prod": "npm run build && nest start",
|
"start:prod": "npm run build && nest start",
|
||||||
|
"test": "jest",
|
||||||
"postinstall": "prisma generate"
|
"postinstall": "prisma generate"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue