Skip to content

Commit

Permalink
feat: update the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tericcabrel committed Nov 7, 2022
1 parent 42bf85a commit 9389872
Showing 1 changed file with 20 additions and 8 deletions.
28 changes: 20 additions & 8 deletions springboot-mongodb/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,23 @@
# Spring Boot with MongoDB
This project show how to use MongoDb in a Spring Boot project.
This project show how to use MongoDB in a Spring Boot project.

# Installation
1. Clone the repository
2. Enter the project's directory
3. Create application.properties file from application-example.properties
4. Update application.properties with your own configuration
5. install maven dependencies `mvn install`
6. run the application `mvn spring-boot:run`
7. Test endpoints with Postman or other REST client

- Clone the repository

- Enter the project's directory

- Create a container of MongoDB

```shell
docker run -d --rm --name championship-db -e MONGO_INITDB_ROOT_USERNAME=root -e MONGO_INITDB_ROOT_PASSWORD=secret mongo:6.0
```
- Create application.properties file from application-example.properties

- Update application.properties with your own configuration

- install maven dependencies `mvn install`

- run the application `mvn spring-boot:run`

- Test endpoints with Postman or other REST client

0 comments on commit 9389872

Please sign in to comment.