https://github.com/hrishabh3829/course-search-spring
Course Search Backend (Spring Boot + Elasticsearch)
https://github.com/hrishabh3829/course-search-spring
spring-boot springweb
Last synced: about 1 month ago
JSON representation
Course Search Backend (Spring Boot + Elasticsearch)
- Host: GitHub
- URL: https://github.com/hrishabh3829/course-search-spring
- Owner: Hrishabh3829
- Created: 2025-07-14T12:47:08.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-07-14T13:05:45.000Z (11 months ago)
- Last Synced: 2025-07-14T16:52:00.499Z (11 months ago)
- Topics: spring-boot, springweb
- Language: Java
- Homepage:
- Size: 24.4 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
🎯 Course Search Backend (Spring Boot + Elasticsearch)
This is a lightweight backend application for searching and filtering courses using Elasticsearch. It supports full-text search, autocomplete, and optional fuzzy matching — built with Spring Boot, Java 17, and tested using Testcontainers.
🚀 Getting Started
1. Prerequisites
- ✅ Java 17
- ✅ Maven 3+
- ✅ Docker (for Elasticsearch container)
2. Clone the Repository
git clone https://github.com/your-username/course-search.git
cd course-search
3. Start Elasticsearch with Docker Compose
docker-compose up -d
4. Run the Spring Boot Application
./mvnw spring-boot:run
5. Verify Initialization
You should see:
👍Courses indexed into Elasticsearch: 50
📌 Features
- 🔍 Full-text search (title, description, category)
- ⚡ Autocomplete suggestions (prefix-based)
- 🤖 Fuzzy matching for typo-tolerance
- 📝 50 sample courses indexed at startup
- 🧪 Integration tests using Testcontainers + JUnit 5
🧱 Tech Stack
TechVersion
Java17
Spring Boot3.2+
Elasticsearch7.17
Spring Data ES✅
Jackson✅
Testcontainers1.19.0
JUnit 55.12.2
🗂️ Project Structure
src/
├── main/
│ ├── java/com/example/coursesearch/
│ │ ├── config/ # Jackson & other app-level configs
│ │ ├── controller/ # API endpoints
│ │ ├── document/ # Elasticsearch @Document definitions
│ │ ├── repository/ # Spring Data Elasticsearch repositories
│ │ └── service/ # Business logic (search, indexing)
│ └── resources/
│ ├── application.yml
│ └── sample-courses.json # Initial 50-course dataset
└── test/ # Integration testing with Testcontainers
🔎 API Endpoints
EndpointMethodDescription
/api/search?q=keyword
GET
Full-text search across title, description, category
/api/search/suggest?q=term
GET
Autocomplete suggestions using Elasticsearch completion field
🧪 Running Tests
./mvnw test
This project uses Testcontainers to spin up a real Elasticsearch instance. Useful to ensure your logic works on actual Elasticsearch behavior.
🙌 How to Use This Project
- Clone the repo
- Start Elasticsearch using
docker-compose up -d
- Run the Spring Boot backend using
./mvnw spring-boot:run
- Open Postman or your browser and hit:
http://localhost:9090/api/search?q=math
http://localhost:9090/api/search/suggest?q=art
👍 Contributing
This project is beginner-friendly. You are welcome to fork the repo and open PRs for improvements or suggestions.
🙏 Acknowledgement
Built as a learning project to explore Spring Boot and Elasticsearch integration. Thanks to the developer community for docs, samples, and support.
👤 Author
Maintained by Hrishabh.
Built with passion, patience, and a focus on clean backend design.