{"id":24819203,"url":"https://github.com/sidd-77/microservices-chat","last_synced_at":"2026-02-14T11:35:00.260Z","repository":{"id":268922790,"uuid":"904604908","full_name":"Sidd-77/microservices-chat","owner":"Sidd-77","description":"Microservices based application designed which uses TypeScript and technologies such as Docker, Kubernetes, Redis Pub/Sub, RabbitMQ, and MinIO for building scalable and maintainable solutions.","archived":false,"fork":false,"pushed_at":"2025-01-15T06:10:46.000Z","size":1433,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-12T00:53:00.878Z","etag":null,"topics":["chat","docker-compose","github-actions","kubernetes","mern","microservices-architecture","pubsub","rabbitmq","redis","turborepo"],"latest_commit_sha":null,"homepage":"https://microservices-chat-docs.vercel.app/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Sidd-77.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-17T08:04:40.000Z","updated_at":"2025-01-23T05:12:52.000Z","dependencies_parsed_at":null,"dependency_job_id":"6e825bd1-3eb9-427e-b07d-a9339c3ad482","html_url":"https://github.com/Sidd-77/microservices-chat","commit_stats":null,"previous_names":["sidd-77/microservices-chat"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sidd-77%2Fmicroservices-chat","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sidd-77%2Fmicroservices-chat/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sidd-77%2Fmicroservices-chat/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sidd-77%2Fmicroservices-chat/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Sidd-77","download_url":"https://codeload.github.com/Sidd-77/microservices-chat/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248501881,"owners_count":21114682,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["chat","docker-compose","github-actions","kubernetes","mern","microservices-architecture","pubsub","rabbitmq","redis","turborepo"],"created_at":"2025-01-30T17:56:53.974Z","updated_at":"2026-02-14T11:34:55.226Z","avatar_url":"https://github.com/Sidd-77.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Project Introduction\n\nThis project is a modern microservices-based application designed to showcase proficiency in advanced software architecture and DevOps practices. It leverages **TypeScript** and cutting-edge technologies such as **Docker**, **Kubernetes**, **Redis Pub/Sub**, **RabbitMQ**, and **MinIO** for building scalable and maintainable solutions.\n\n## Key Features\n- **Microservices Architecture:** The application consists of modular services that are independently deployable and scalable.\n- **Message Queues:** Asynchronous communication is enabled through RabbitMQ.\n- **Redis Pub/Sub:** Facilitates real-time updates and inter-service communication.\n- **Kubernetes:** Ensures orchestration of microservices for scalable deployment.\n- **MinIO:** Provides S3-compatible file storage.\n- **Turborepo:** Manages the monorepo, allowing shared configurations and code reuse.\n\n\n## Architecture\n![diagram-export-1-6-2025-1_05_00-PM](https://github.com/user-attachments/assets/28e39518-45d0-42e4-be7a-a45fe75a0b8c)\n\n\n## Directory Structure\n```\n├── apps\n│   ├── auth-service          # Handles authentication and authorization\n│   ├── db-service            # Database-related tasks and abstraction\n│   ├── docs                  # Documentation for the project\n│   ├── file-service          # File upload and management\n│   ├── notification-service  # Notifications using custom WAPT-based system\n│   ├── socket-service        # Real-time communication using Socket.IO\n│   └── web                   # Frontend application using RailJS\n├── docker-compose-dependencies.yml # Docker dependencies for local setup\n├── docs                      # Service-specific documentation\n├── k8s                       # Kubernetes manifests for services\n├── packages\n│   ├── eslint-config         # Shared ESLint configuration\n│   ├── models                # Shared models for microservices\n│   └── typescript-config     # Shared TypeScript configuration\n├── setup.js                  # Setup script for local environment\n├── turbo.json                # Turborepo configuration\n```\n\n---\n\n\n# Setting Up the Project Locally for Developement\n\nFollow these steps to set up the project on your local machine:\n\n## Prerequisites\n- **Node.js (\u003e=18)**\n- **Docker and Docker Compose**\n\n## Steps\n\n1. **Clone the Repository:**\n    ```bash\n    git clone https://github.com/Sidd-77/microservices-chat.git\n    cd microservices-chat\n    ```\n\n2. **Install Dependencies:**\n    Install all dependencies in the root and subdirectories:\n    ```bash\n    npm install\n    ```\n\n3. **Run Setup Script:**\n    Execute the setup script to configure the environment:\n    ```bash\n    node setup.js\n    ```\n\n4. **Build Project:**\n    Build the services and models needed:\n    ```bash\n    npm run build\n    ```\n\n5. **Start Dependencies Locally:**\n    Use Docker Compose to start dependencies like Redis, RabbitMQ, MongoDB and MinIO:\n    ```bash\n    docker-compose -f docker-compose-dependencies.yml up -d\n    ```\n\n6. **Run the Application:**\n    Start the application using npm:\n    ```bash\n    npm run dev\n    ```\n\n\u003e **Note for Notification Service:**\n\u003e To enable the push-notification service, generate a VAPID key pair and place it in the environment files of both the `web` and `notification-service` directories.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsidd-77%2Fmicroservices-chat","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsidd-77%2Fmicroservices-chat","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsidd-77%2Fmicroservices-chat/lists"}