This is the final project of the n11 TalentHub Backend Bootcamp. It features a restaurant recommendation system built on top of Apache Solr, developed using a microservices architecture.
LinkedIn: Selim Sahin
GitHub: selimsahindev
- Unit and integration tests are written.
- Each core service has its own dedicated database.
- Asynchronous messaging is handled via Kafka.
- MongoDB is used for log storage.
- Eureka service discovery is configured.
- A simple frontend is built with Next.js.
- A
docker-compose.ymlfile is provided. - Swagger API documentation is included.
- The API can be tested via Postman.
To learn how to run the project with Docker, see the Docker section.
You can test all API endpoints using Postman: Postman API 🚀
The following microservices are part of the project:
- 📦 User Service
- 📦 Restaurant Service
- 📦 Recommendation Service
- 🐝 Log Aggregation Service
- ⛩️ API Gateway
- 🌐 Eureka Service Discovery
You can run the project using Docker. Download Docker Desktop from the official Docker website.
- Open a terminal and navigate to the root directory of the project.
- Run
docker-compose up -d. - Wait for all services to start. (This may take a while — be patient.)
- Once all services are up, the API should be ready to use.
- To run the frontend, refer to the Next.js section below.
To stop the project, navigate to the root directory and run docker-compose down.
Note: Docker is sufficient to run the backend. However, running the frontend requires Node.js and npm.
The Next.js project provides a simple frontend that allows users to view nearby restaurant recommendations and browse all available restaurants.
- Open a terminal and navigate to the root directory of the project.
- Run
cd nextjs-frontendto enter the frontend directory. - Run
npm installand wait for dependencies to be installed. - Run
npm run devto start the development server. - Open your browser and go to
http://localhost:3000.
If you've made it this far — great! You're all set. 🎉🎉🎉
User Service — user-service
The User Service is a foundational microservice responsible for user data management. It uses its own dedicated PostgreSQL database.
Service class names are suffixed with
.javato distinguish them from the microservices themselves.
UserService (UserService.java)
Handles user management, including creation, update, and deletion operations.
| Method | Path | Description |
|---|---|---|
GET |
user-service/api/v1/users |
Get all users |
GET |
user-service/api/v1/users/{id} |
Get user by ID |
POST |
user-service/api/v1/users |
Create a new user |
PUT |
user-service/api/v1/users/{id} |
Update a user |
DELETE |
user-service/api/v1/users/{id} |
Delete a user |
UserReviewService (UserReviewService.java)
Manages user reviews for restaurants, including creation, update, and deletion.
| Method | Path | Description |
|---|---|---|
GET |
user-service/api/v1/user-reviews |
Get all user reviews |
GET |
user-service/api/v1/user-reviews/{id} |
Get a review by ID |
GET |
user-service/api/v1/user-reviews/by-user?userId={id} |
Get all reviews by a specific user |
POST |
user-service/api/v1/user-reviews |
Create a new user review |
Restaurant Service — restaurant-service
| Method | Path | Description |
|---|---|---|
GET |
restaurant-service/api/v1/restaurants |
Get all restaurants |
GET |
restaurant-service/api/v1/restaurants/{id} |
Get a restaurant by ID |
POST |
restaurant-service/api/v1/restaurants |
Create a new restaurant |
DELETE |
restaurant-service/api/v1/restaurants/{id} |
Delete a restaurant |
Recommendation Service — recommendation-service
The Recommendation Service provides restaurant suggestions based on user reviews and location data, powered by Apache Solr.
| Method | Path | Description |
|---|---|---|
GET |
recommendation-service/api/v1/search/restaurants |
Get all restaurants indexed in Solr |
GET |
/api/v1/search/restaurants/by-location-near?location={latitude},{longitude} |
Get up to three nearby restaurants at a given location |
Log Aggregation Service — log-aggregation-service
This service collects error and info logs produced by other microservices and stores them in a MongoDB database. A REST API is provided to access the stored logs. The project also includes Mongo Express for managing the MongoDB database — see Mongo Express.
| Method | Path | Description |
|---|---|---|
GET |
log-aggregation-service/api/v1/info-logs |
Get all info logs |
GET |
log-aggregation-service/api/v1/error-logs |
Get all error logs |
API Gateway — api-gateway
The API Gateway exposes all microservice APIs through a single unified entry point and resolves service addresses dynamically via Eureka.
Eureka Server — eureka-server
The Eureka Server acts as a service registry where all microservices register themselves. The API Gateway uses Eureka to discover and route requests to the appropriate services.
Mongo Express is a web-based UI for managing the MongoDB database included in this project.
- With Docker running, open your browser and go to
http://localhost:8081. - Default credentials: username
admin, passwordpass. - Select your MongoDB database and start managing it.
Users can see the top three highest-rated restaurants closest to their location.
Users can browse the full list of available restaurants.
A warm and welcoming registration screen.
LinkedIn: Selim Sahin
GitHub: selimsahindev