Skip to content

Commit d29648e

Browse files
committed
doc: add more information to readme
1 parent 3edaf09 commit d29648e

File tree

2 files changed

+16
-0
lines changed

2 files changed

+16
-0
lines changed

api/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ This folder contains the backend API for Jardin Mental, built with Node.js, Expr
88

99
## Local Development Setup
1010

11+
> **Important:** In local development, only **Postgres** and **Maildev** run in Docker containers. The Node.js API runs directly on your machine (not in a container).
12+
1113
### Prerequisites
1214

1315
- **Node.js** (version 14 or higher)
@@ -22,6 +24,8 @@ pnpm install
2224

2325
### 2. Start Database and Maildev
2426

27+
> **Note:** Make sure Docker is installed and running before executing this command.
28+
2529
From the `api` directory, run:
2630

2731
```bash
@@ -60,6 +64,16 @@ This will start:
6064
pnpm test
6165
```
6266

67+
### 6. Run Cron Jobs (Optional)
68+
69+
The cron job sends scheduled notifications. To run it manually:
70+
71+
From the `api` directory, run:
72+
73+
```bash
74+
node reminderCronJobRunner.js
75+
```
76+
6377
---
6478

6579
## Docker Usage

app/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ pnpm install
2222

2323
## Running the App
2424

25+
> **Note:** All commands below must be run from the `app` folder.
26+
2527
### Start the development server
2628

2729
```bash

0 commit comments

Comments
 (0)