LinkedIn Clone

Version : 1.1.43

This project's structure and ideas are the same as he real linkedIn webiste

How to Use Project Documents

The Linkedin project has been designed and generated using Mindbricks, a powerful microservice-based backend generation platform. All documentation is automatically produced by the Mindbricks Genesis Engine, based on the high-level architectural patterns defined by the user or inferred by AI.

This documentation set is intended for both AI agents and human developers—including frontend and backend engineers—who need precise and structured information about how to interact with the backend services of this project. Each document reflects the live architecture of the system, providing a reliable reference for API consumption, data models, authentication flows, and business logic.

By following this documentation, developers can seamlessly integrate with the backend, while AI agents can use it to reason about the service structure, make accurate decisions, or even generate compatible client-side code.

Accessing Project Services

Each service generated by Mindbricks is exposed via a dedicated REST API endpoint. Every service documentation set includes the base URL of that service along with the specific API paths for each available route.

Before consuming any API, developers or agents must understand the service URL structure and environment-specific endpoints.

Service Endpoint Structure

Replace auth with the actual service name as lower case (e.g., order-api, bff-service, customermanagement-api etc.).

Environment Usage Notes

• Preview APIs become accessible after a project is previewed inside the Mindbricks platform. These are ideal for development and testing.
• Staging and Production APIs are only accessible after the project is deployed to cloud environments provisioned via Mindbricks.
• In some cases, the project owner may choose to deploy services on their own infrastructure. In such scenarios, the service base URLs will be custom and should be communicated manually by the project owner to developers or AI agents.

Frontend applications should be designed to easily switch between environments, allowing dynamic endpoint targeting for Preview, Staging, and Production.

Getting Started: Use the Auth Service First

Before interacting with other services in the Linkedin project, AI agents and developers should begin by integrating with the Auth Service.

Mindbricks automatically generates a dedicated authentication microservice based on the project’s authentication definitions provided by the architect. This service provides the essential user and access management foundation for the project.

Agents should first utilize the Auth Service to:

• Register and authenticate users (login)
• Manage users, roles, and permissions
• Handle user groups (if defined)
• Support multi-tenancy logic (if configured)
• Perform Policy-Based Access Control (PBAC), if activated by the architect

Auth Service Documentation

Use the following resources to understand and integrate the Auth Service:

• REST API Guide – ideal for frontend and direct HTTP usage
  https://linkedin.prw.mindbricks.com/document/auth-service/rest-api-guide

• Event Guide – helpful for event-driven or cross-service integrations
  https://linkedin.prw.mindbricks.com/document/auth-service/event-guide

• Service Design Document – overall structure, patterns, and logic
  https://linkedin.prw.mindbricks.com/document/auth-service/service-design

Note: For most frontend use cases, the REST API Guide will be the primary source. The Event Guide and Service Design documents are especially useful when integrating with other backend microservices or building systems that interact with the auth service indirectly.

Using the BFF (Backend-for-Frontend) Service

In Mindbricks, all backend services are designed with an advanced CQRS (Command Query Responsibility Segregation) architecture. Within this architecture, business services are responsible for managing their respective domains and ensuring the accuracy and freshness of domain data.

The BFF service complements these business services by providing a read-only aggregation and query layer tailored specifically for frontend and client-side applications.

Key Principles of the BFF Service

• Elasticsearch Replicas for Fast Queries:
  Each data object managed by a business service is automatically replicated as an Elasticsearch index, making it accessible for fast, frontend-oriented queries through the BFF.

• Cross-Service Data Aggregation:
  The BFF offers an aggregation layer capable of combining data across multiple services, enabling complex filters, searches, and unified views of related data.

• Read-Only by Design:
  The BFF service is strictly read-only. All create, update, or delete operations must be performed through the relevant business services, or via event-driven sagas if designed.

BFF Service Documentation

• REST API Guide – querying aggregated and indexed data
  https://linkedin.prw.mindbricks.com/document/bff-service/rest-api-guide

• Event Guide – syncing strategies across replicas
  https://linkedin.prw.mindbricks.com/document/bff-service/event-guide

• Service Design – aggregation patterns and index structures
  https://linkedin.prw.mindbricks.com/document/bff-service/service-design

Tip: Use the BFF service as the main entry point for all frontend data queries. It simplifies access, reduces round-trips, and ensures that data is shaped appropriately for the UI layer.

Business Services Overview

The LinkedIn Clone project consists of multiple business services, each responsible for managing a specific domain within the system. These services expose their own REST APIs and documentation sets, and are accessible based on the environment (Preview, Staging, Production).

Usage Guidance

Business services are primarily designed to:

• Handle the state and operations of domain data
• Offer Create, Update, Delete operations over owned entities
• Serve direct data queries (get, list) for their own objects when needed

For advanced query needs across multiple services or aggregated views, prefer using the BFF service.

Available Business Services

jobApplication Service

Description: Microservice handling job postings (created by recruiters/company admins), job applications (created by users), allowing job search, application submission, and status update workflows. Enforces business rules around application status, admin controls, and lets professionals apply and track job applications .within the network.

Documentation:

• REST API Guide
• Event Guide
• Service Design

Base URL Examples:

networking Service

Description: Handles professional networking logic for user-to-user connections: manages connection requests, accepted relationships, listing/removal, permissions, and state transitions. Publishes connection lifecycle events for notification...

Documentation:

• REST API Guide
• Event Guide
• Service Design

Base URL Examples:

company Service

Description: Handles company profiles, company admin assignments, company following, and posting company updates/news. Enables professionals to follow companies, get updates, and enables admins to manage company presence..

Documentation:

• REST API Guide
• Event Guide
• Service Design

Base URL Examples:

content Service

Description: Handles creation, editing, and deletion of user posts (with attachments and visibility), user post feed aggregation, and post engagement (likes, comments). All with post-level visibility control (public/private)..

Documentation:

• REST API Guide
• Event Guide
• Service Design

Base URL Examples:

messaging Service

Description: Handles direct, private 1:1 and group messaging between users, conversation management, and message history/storage..

Documentation:

• REST API Guide
• Event Guide
• Service Design

Base URL Examples:

profile Service

Description: Handles user professional profiles, including experience, education, skills, languages, certifications, profile photo, and visibility controls. Enables recruiter search, elastic-style indexing, and profile editing, with all data linked to authenticated users..

Documentation:

• REST API Guide
• Event Guide
• Service Design

Base URL Examples:

Conclusion

This documentation set provides a comprehensive guide for understanding and consuming the LinkedIn Clone backend, generated by the Mindbricks platform. It is structured to support both AI agents and human developers in navigating authentication, data access, service responsibilities, and system architecture.

To summarize:

• Start with the Auth Service to manage users, roles, sessions, and permissions.
• Use the BFF Service for optimized, read-only data queries and cross-service aggregation.
• Refer to the Business Services when you need to manage domain-specific data or perform direct CRUD operations.

Each service offers a complete set of documentation—REST API guides, event interface definitions, and design insights—to help you integrate efficiently and confidently.

Whether you are building a frontend application, configuring an automation agent, or simply exploring the architecture, this documentation is your primary reference for working with the backend of this project.

For environment-specific access, ensure you're using the correct base URLs (Preview, Staging, Production), and coordinate with the project owner for any custom deployments.