Skip to content

Commit 569fd5f

Browse files
committed
Add README.md
1 parent 53573d6 commit 569fd5f

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Logging Sample
2+
3+
Sample of how to use the ELK stack with Spring Boot.
4+
5+
## Prerequisites
6+
7+
1. Java 8
8+
2. Docker Compose
9+
3. Docker
10+
11+
12+
## Running Locally
13+
1. Run the ELK docker compose file
14+
```shell script
15+
$ docker-compose up -d
16+
```
17+
2. Once the ELK stack is started, navigate to the [kibana dashboard](http://localhost:5601)
18+
3. Run the application
19+
```shell script
20+
$ ./gradlew bootrun
21+
```
22+
23+
## Contributing
24+
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
25+
26+
Please make sure to update tests as appropriate.
27+
28+
## License
29+
[MIT](https://choosealicense.com/licenses/mit/)

0 commit comments

Comments
 (0)