Skip to content

Commit 33a05bb

Browse files
committed
update readme
1 parent f3be12f commit 33a05bb

File tree

2 files changed

+14
-3
lines changed

2 files changed

+14
-3
lines changed

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626

2727

2828
## **How to launch**
29-
> To launch application tou need to install `Docker` and `Docker Compose` on your system
29+
> To launch application you need to install `Docker` and `Docker Compose` on your system
3030
3131
1. Clone git repository and go to the directory
3232
``` Shell
@@ -39,6 +39,17 @@ cd NodeNotes
3939
docker compose up --build
4040
```
4141

42+
## **Environment variables**
43+
44+
1. `DATABASE_HOST`
45+
2. `DATABASE_NAME`
46+
3. `DATABASE_USER`
47+
4. `DATABASE_PASSWORD`
48+
5. `REDIS_CONNECTION_STRING` (ex. `redis://127.0.0.1:6379/0`)
49+
6. `JWT_SECRET`
50+
7. `JWT_EXPIRATION` (ex. `24h`)
51+
8. `PORT`
52+
4253
## **`Jest` unit tests**
4354
- App covered with `Jest` unit tests
4455
- Coverage `85%`

source/api/v1/shared/config/ServerConfiguration.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ export const CONFIG: Config = {
66

77
databaseHost: process.env.DATABASE_HOST || "localhost",
88
databasePort: parseInt(process.env.DATABASE_PORT || "5432"),
9-
databaseName: process.env.DATABASE_NAME || "NodeNotes",
9+
databaseName: process.env.DATABASE_NAME || "postgres",
1010
databaseUser: process.env.DATABASE_USER || "postgres",
11-
databasePassword: process.env.DATABASE_PASSWORD || "Rrobocopid12",
11+
databasePassword: process.env.DATABASE_PASSWORD || "postgres",
1212

1313
get databaseConnectionString(): string {
1414
return `postgres://${this.databaseUser}:${this.databasePassword}@${this.databaseHost}:${this.databasePort}/${this.databaseName}`

0 commit comments

Comments
 (0)