Skip to content

Commit

Permalink
docs: Add Docker Compose file to simplify contributions (#532)
Browse files Browse the repository at this point in the history
  • Loading branch information
danilofuchs authored Jan 8, 2025
1 parent f33bdb4 commit 9760424
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,4 +82,10 @@ To run the test suite, linter and code coverage:
npm run cover
```

The test suite will try and create a new database named pgboss. The [config.json](test/config.json) file has the default credentials to connect to postgres.
The test suite will try and create a new database named pgboss. The [config.json](test/config.json) file has the default credentials to connect to postgres.

The [Docker Compose](docker-compose.yaml) file can be used to start a local postgres instance for testing:

```bash
docker-compose up -d
```
15 changes: 15 additions & 0 deletions docker-compose.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
services:
db:
image: postgres:16
ports:
- 5432:5432
volumes:
- db_volume:/var/lib/postgresql/data
environment:
- POSTGRES_DB=pgboss
- POSTGRES_NAME=pgboss
- POSTGRES_USER=postgres
- POSTGRES_PASSWORD=postgres

volumes:
db_volume:

0 comments on commit 9760424

Please sign in to comment.