Skip to content

Commit 338d3d6

Browse files
authored
Update README.md
1 parent e5785dd commit 338d3d6

File tree

1 file changed

+19
-15
lines changed

1 file changed

+19
-15
lines changed

README.md

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
![Spring Boot](https://img.shields.io/badge/Spring%20Boot-6DB33F?style=for-the-badge&logo=springboot&logoColor=white)
2+
![Elasticsearch](https://img.shields.io/badge/Elasticsearch-005571?style=for-the-badge&logo=elasticsearch&logoColor=white)
3+
![Docker](https://img.shields.io/badge/Docker-2496ED?style=for-the-badge&logo=docker&logoColor=white)
4+
![Docker Compose](https://img.shields.io/badge/Docker%20Compose-2496ED?style=for-the-badge&logo=docker&logoColor=white)
5+
6+
17
# Hibernate Search 6 Example
28

39
Simple Spring Boot application demonstrating Hibernate Search 6 usage with Elasticsearch.
@@ -10,15 +16,14 @@ ER diagram:
1016

1117
![ER diagram](./documentation/ERD.influncers.drawio.png)
1218

13-
Full text search is available for Freelancer and Project entities.
19+
**Full text search is available for Freelancer and Project entities.**
1420

1521
Indexing Entities
1622
- [Project](./backend/src/main/java/com/netz00/hibernatesearch6example/model/Project.java)
1723
- [Freelancer](./backend/src/main/java/com/netz00/hibernatesearch6example/model/Freelancer.java)
1824
- [Freelancer categories](./backend/src/main/java/com/netz00/hibernatesearch6example/model/Category.java)
1925

20-
3 search examples:
21-
26+
**3 search examples:**
2227
- [searchProjectsEntities](./backend/src/main/java/com/netz00/hibernatesearch6example/services/ProjectServiceImpl.java)
2328
demonstrates basic full text search of projects by
2429
- project name
@@ -33,22 +38,21 @@ demonstrates full text search of freelancers (with projections) by
3338
- last name
3439
- categories (M:N relationship)
3540

36-
Creating custom
37-
[edgeNgram analyser](./backend/src/main/java/com/netz00/hibernatesearch6example/config/MyElasticsearchAnalysisConfigurer.java)
38-
39-
## Running
40-
41-
Before running Spring Boot application start necessary Docker containers with the following commands:
41+
**Creating custom
42+
[edgeNgram analyser](./backend/src/main/java/com/netz00/hibernatesearch6example/config/MyElasticsearchAnalysisConfigurer.java)**
4243

43-
- Start development environment with:
44-
`docker compose -f deployment/docker-compose-dev.yaml up -d`
44+
## Running the Application
4545

46-
- Stop development environment with:
47-
`docker compose -f deployment/docker-compose-dev.yaml down`
46+
Before starting the Spring Boot application, ensure that the necessary Docker containers are running.
47+
```bash
48+
docker compose -f deployment/docker-compose-dev.yaml up -d
49+
```
4850

49-
Run tests with the following command:
5051

51-
`newman run ./backend/src/test/postman/Hibernate-search-6-example.postman_collection.json -e ./backend/src/test/postman/Test\ Environment.postman_environment.json --reporters cli,json --reporter-json-export ./backend/src/test/postman/output/outputfile.json `
52+
Running Tests:
53+
```bash
54+
newman run ./backend/src/test/postman/Hibernate-search-6-example.postman_collection.json -e ./backend/src/test/postman/Test\ Environment.postman_environment.json --reporters cli,json --reporter-json-export ./backend/src/test/postman/output/outputfile.json
55+
```
5256

5357
Import postman collection from [here](./backend/src/test/postman/Hibernate-search-6-example.postman_collection.json)
5458

0 commit comments

Comments
 (0)