Elasticsearch Configuration Jar

📋 Table of Contents

1. 🤖 Introduction
2. ⚙️ Tech Stack
3. 🔋 Documentation
4. 🤸 Quick Start
5. 🕸️ Contributing
6. 🔗 Links
7. 🙏 Support
8. ✨ Contributors

🤖 Introduction

The Elasticsearch Configuration JAR is a critical component within Bloggios Microservices architecture. Built using Java 17 and Spring Boot, and leveraging the Spring Boot Parent, this JAR dependency provides advanced capabilities such as searching, sorting, filtering, fuzzy searching, and more, utilizing the * Elasticsearch engine*. It serves as a centralized library for other microservices, ensuring a consistent and efficient approach to handling Elasticsearch operations.

Key Features

1. Advanced Search Capabilities:

   • Implements powerful search functionalities including full-text search, multi-field search, and more, leveraging the robust capabilities of the Elasticsearch engine.

2. Sorting and Filtering:

   • Provides comprehensive sorting and filtering options, enabling precise data retrieval and organization based on various criteria and fields.

3. Fuzzy Searching:

   • Supports fuzzy searching to handle typographical errors and approximate matches, enhancing user experience by delivering relevant results even with imperfect input.

4. Centralized Configuration:

   • Acts as a centralized configuration library for all microservices within the Bloggios architecture, ensuring consistency and reducing redundancy in Elasticsearch operations.

5. High Performance:

   • Optimized for high performance, ensuring fast and efficient data retrieval, which is critical for applications requiring real-time search capabilities.

Benefits

• Consistent Implementation Across Microservices:

  • By serving as a centralized configuration library, the Elasticsearch Configuration JAR ensures that all microservices within the Bloggios architecture implement Elasticsearch functionalities in a consistent and standardized manner.

• Time and Effort Savings:

  • Developers save considerable time and effort as they do not need to repeatedly configure Elasticsearch for each microservice. This centralized approach reduces redundancy and streamlines the development process.

Join our newly active Discord community for support, bug reporting, and feature requests. Here, we strive to address every issue, and developers and testers can collaborate and assist each other effectively.

⚙️ Tech Stack

• Java 17
• Spring Boot
• Elasticsearch
• Elastic High Level Client

🔋 API Documentation

To help you get started with our API and understand all its features and endpoints, we have created detailed documentation available on Postman. This documentation includes comprehensive information about each endpoint, including:

• Endpoint URLs: Specific paths to access various functionalities.
• HTTP Methods: The method type (GET, POST, PUT, DELETE, etc.) for each endpoint.
• Parameters: Required and optional parameters, including headers, query parameters, and body content.
• Request Examples: Sample requests to demonstrate proper usage.
• Response Formats: Expected response structure, including status codes and data formats.
• Error Handling: Common error responses and troubleshooting tips.

To access the documentation:

1. **Visit our Postman Documentation Page **: Visit Documentation
2. Explore the Collection: Navigate through the collection to find detailed descriptions and examples for each endpoint.
3. Run Requests Directly in Postman: Use the "Run in Postman" button to directly import the collection into your Postman workspace for testing and exploration.

By leveraging the Postman documentation, you can quickly integrate our API into your application and take full advantage of its capabilities.

For any further assistance, feel free to contact our support team or refer to the additional resources section in the documentation.

🤸 Quick Start

Follow these steps to set up the project locally on your machine.

Prerequisites

Make sure you have the following installed on your machine:

• Git
• Java 17
• Intellij Idea or any other IDE supports Spring Boot

Cloning the Repository

git clone <repository-url>

Opening the Project

Open the project in any of your favourite IDE We recommended Intellij Idea

Make sure you have Java 17 Installed in your system Please execute the below command to check installed version of Java in your system

java --version

Replace the placeholder values with your actual credentials

Running or Compiling the Project

This is the configuration file repository only so there is no need to run this Repository

One can create a Jar of this application and use it in the other Microservices of Bloggios to Create a Jar please run the below command on root directory

mvn clean install

If Maven is not installed in your system then run

./mvnw clean install

🧑‍💻Contributing

Any kind of positive contribution is welcome! Please help us to grow by contributing to the project.

If you wish to contribute, you can,

• Star Repositories Bloggios
• Suggest a Feature
• Test the application, and help it improve.
• Improve the app, fix bugs, etc.
• Improve documentation.
• Create content about Bloggios and share it with the world.

Please read CONTRIBUTING for details on our CODE OF CONDUCT, and the process for submitting pull requests to us.

🆕 New to Open Source? 💡 Follow this guide to jumpstart your Open Source journey 🚀.

🔗 Links

• Devsanbox API's URL - https://api.bloggios.in (Bloggios Devsandbox API)
• Devsandbox Environment - https://dev.bloggios.in (Bloggios Devsandbox) (Not Deployed yet)
• Production Environment - Not Deployed yet

Repositories

• Auth Provider Application - Visit Github
• User Provider Application - Visit Github
• Bloggios Mail Service - Visit Github
• Authentication Configuration Jar - Visit Github
• Bloggios Web UI - Visit Github

🙏Support

We all need support and motivation. Bloggios is not an exception. Please give this project repositories a ⭐️ to encourage and show that you liked it. Don't forget to leave a star ⭐️ before you move away.

If you found the app helpful, consider supporting us with a coffee.

✨Contributors

Thanks goes to these wonderful people (emoji key):

Rohit Parihar 💻