Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Microservice pattern: Client-side UI composition #2698

Open
iluwatar opened this issue Oct 15, 2023 · 7 comments · May be fixed by #3062
Open

Microservice pattern: Client-side UI composition #2698

iluwatar opened this issue Oct 15, 2023 · 7 comments · May be fixed by #3062

Comments

@iluwatar
Copy link
Owner

iluwatar commented Oct 15, 2023

Description:

The Client-Side UI Composition pattern is a design strategy used in microservices architectures to assemble the user interface on the client side. This pattern is particularly useful in complex applications where the UI is composed of multiple components, each served by different microservices. The key elements of this pattern include:

  1. Micro Frontends: Each UI component is developed and deployed independently, often by different teams, ensuring modularity and flexibility.
  2. API Gateway: Serves as a single entry point for the client, routing requests to the appropriate microservice.
  3. Integration Layer: Manages the integration of various UI components into a cohesive user experience on the client side.
  4. Asynchronous Data Fetching: Each component fetches its data asynchronously, often using techniques like AJAX or WebSockets.

References:

Acceptance Criteria:

  1. Micro Frontends Implementation:

    • Create multiple independent frontend modules.
    • Ensure each module can be developed, tested, and deployed independently.
  2. API Gateway Configuration:

    • Implement an API Gateway that routes client requests to the appropriate microservice.
    • Ensure secure and efficient routing.
  3. Client-Side Integration Layer:

    • Develop an integration layer that dynamically assembles the UI components on the client side.
    • Ensure seamless communication between components.
  4. Asynchronous Data Fetching:

    • Implement asynchronous data fetching for each UI component.
    • Ensure data is fetched and displayed in a non-blocking manner to enhance user experience.
  5. Documentation and Testing:

    • Provide detailed documentation on how to set up and use the Client-Side UI Composition pattern.
    • Write comprehensive tests to ensure the integrity and functionality of the integrated UI.
@kavitha186
Copy link

Can i work on this . Please assign it to me

@kavitha186
Copy link

@iluwatar I'm using American Express One app framework and going to build a holocron module. Is that fine?

@iluwatar
Copy link
Owner Author

Yes, that should be fine

Copy link

stale bot commented May 22, 2024

This issue has been automatically marked as stale because it has not had recent activity. The issue will be unassigned if no further activity occurs. Thank you for your contributions.

@stale stale bot added the status: stale issues and pull requests that have not had recent interaction label May 22, 2024
@stale stale bot removed the status: stale issues and pull requests that have not had recent interaction label May 22, 2024
@iluwatar iluwatar added info: help wanted status: stale issues and pull requests that have not had recent interaction labels May 22, 2024
@stale stale bot removed the status: stale issues and pull requests that have not had recent interaction label May 22, 2024
@TarunVishwakarma1
Copy link

Hi There, I want to work on this, should I create a new project named - client-side-ui-composition ?
I didn't find any related code file for this in the current repo, So I'm guessing that new project has to be made.

Please guide me if I'm wrong or any particular idea you have in mind.

@iluwatar
Copy link
Owner Author

Yes, for the submodule name I would propose microservices-client-side-ui-composition.

@TarunVishwakarma1
Copy link

TarunVishwakarma1 commented Oct 13, 2024

Sure, I'll get started right now. A little request can you add hacktober fest lable to this. Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: In Progress
Development

Successfully merging a pull request may close this issue.

3 participants