Skip to content

Commit 7188fa2

Browse files
author
Luong Quang Manh
committed
Update and reformat README.md, docker-compose.yaml
1 parent 1cb42a1 commit 7188fa2

File tree

2 files changed

+9
-8
lines changed

2 files changed

+9
-8
lines changed

README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,16 @@ Status: **Unstable**
1616
- PostgreSQL >= 12
1717
- PostgREST >= 7
1818

19-
### Local Postgrest Server
20-
If you want to use local postgrest server for development use docker-compose to start local server. Once docker-compose process started, postgrest is accessible at http://localhost:3000
19+
### Local PostgREST server
20+
21+
If you want to use a local PostgREST server for development, you can use our preconfigured instance via Docker Compose.
22+
2123
```sh
2224
docker-compose up
2325
```
2426

27+
Once Docker Compose started, PostgREST is accessible at http://localhost:3000.
28+
2529
### Instructions
2630

2731
#### With Poetry (recommended)

docker-compose.yaml

+3-6
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
version: '3'
1+
version: "3"
22
services:
33
server:
44
image: postgrest/postgrest
@@ -7,7 +7,7 @@ services:
77
environment:
88
PGRST_DB_URI: postgres://app_user:password@db:5432/app_db
99
PGRST_DB_SCHEMA: public
10-
PGRST_DB_ANON_ROLE: app_user #In production this role should not be the same as the one used for the connection
10+
PGRST_DB_ANON_ROLE: app_user # In production this role should not be the same as the one used for connection
1111
PGRST_OPENAPI_SERVER_PROXY_URI: "http://127.0.0.1:3000"
1212
depends_on:
1313
- db
@@ -19,10 +19,7 @@ services:
1919
POSTGRES_DB: app_db
2020
POSTGRES_USER: app_user
2121
POSTGRES_PASSWORD: password
22-
# Uncomment this if you want to persist the data.
23-
# create your boostrap sql file in root directory
22+
# Uncomment this if you want to persist the data. Create your boostrap SQL file in the project root
2423
# volumes:
2524
# - "./pgdata:/var/lib/postgresql/data"
2625
# - "./init.sql:/docker-entrypoint-initdb.d/init.sql"
27-
28-

0 commit comments

Comments
 (0)