Skip to content

Commit cb4acec

Browse files
authored
Update README with requirements and dev mode instructions
1 parent f38b624 commit cb4acec

1 file changed

Lines changed: 25 additions & 0 deletions

File tree

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,26 @@
11
# Sarge
2+
3+
### Requirements:
4+
5+
- PNPM
6+
- Docker
7+
-
8+
9+
### Running in Dev Mode:
10+
11+
Add the following env variables to a .env file:
12+
13+
```
14+
DB_USER="postgres"
15+
DB_PASSWORD="password"
16+
DB_NAME="sarge"
17+
18+
DEV_DATABASE=postgresql://${DB_USER}:${DB_PASSWORD}@localhost:5432/${DB_NAME}
19+
```
20+
21+
Run the following commands in order
22+
23+
- `pnpm install`
24+
- `pnpm run dev`
25+
- Once you are finished run `docker-compose down`
26+

0 commit comments

Comments
 (0)