Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
SuppieRK authored Apr 24, 2024
1 parent d9beb20 commit b6ff790
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,19 @@ The command typically used to build the project is:

* [Testcontainers](https://www.testcontainers.org/)

### Setting up test environment

- You need typical Spring Boot project for testing with Spring Cache / Spring Web for invoking something to trigger the cache.
- Spin up local Redis instance by using
```shell
docker run -d --name redis -p 6379:6379 redis:7.2.4-alpine
```
- Spin up Redis Insight dashboard to observe Redis state by using:
```shell
docker run -d --name redisinsight -p 5540:5540 redis/redisinsight:latest -v redisinsight:/data
```
- Redis Insight woiuld be typically available at http://localhost:5540, your Redis URL to connect would typically have IP of your Docker Machine: look into Redis container network setting by running `docker inspect redis` (typically IP would look like `172.17.0.2` or similar).

## Code of Conduct

### Our Pledge
Expand Down Expand Up @@ -128,4 +141,4 @@ This Code of Conduct is adapted from the [Contributor Covenant][homepage], versi
available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
[version]: http://contributor-covenant.org/version/1/4/

0 comments on commit b6ff790

Please sign in to comment.