{"id":29246459,"url":"https://github.com/iamarvy/nexlink","last_synced_at":"2026-04-12T10:45:46.372Z","repository":{"id":293073448,"uuid":"982883605","full_name":"iamArvy/Nexlink","owner":"iamArvy","description":"Dreamscape is a modern, scalable social media platform built with a microservices architecture. It enables users to post updates, view and engage with content, like and comment on posts, and communicate in real time via direct messages and group chats.","archived":false,"fork":false,"pushed_at":"2025-07-01T18:36:26.000Z","size":8319,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-01T19:37:21.132Z","etag":null,"topics":["docker","ecs-fargate","event-driven-architecture","jwt","microservices","nestjs","nuxtjs","sqs","typescript","websockets"],"latest_commit_sha":null,"homepage":"","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/iamArvy.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,"zenodo":null}},"created_at":"2025-05-13T14:45:30.000Z","updated_at":"2025-07-01T18:36:30.000Z","dependencies_parsed_at":"2025-05-13T15:34:27.080Z","dependency_job_id":"617b4211-7021-43b8-ae0b-a58b45845cde","html_url":"https://github.com/iamArvy/Nexlink","commit_stats":null,"previous_names":["iamarvy/dreamscape","iamarvy/newdreamscape","iamarvy/nexlink"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/iamArvy/Nexlink","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iamArvy%2FNexlink","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iamArvy%2FNexlink/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iamArvy%2FNexlink/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iamArvy%2FNexlink/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/iamArvy","download_url":"https://codeload.github.com/iamArvy/Nexlink/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iamArvy%2FNexlink/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268229854,"owners_count":24217016,"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","status":"online","status_checked_at":"2025-08-01T02:00:08.611Z","response_time":67,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["docker","ecs-fargate","event-driven-architecture","jwt","microservices","nestjs","nuxtjs","sqs","typescript","websockets"],"created_at":"2025-07-03T23:02:00.799Z","updated_at":"2026-04-07T08:32:34.085Z","avatar_url":"https://github.com/iamArvy.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 💬 Nexlink\n\nA scalable, modular **Social Media Backend** built with **NestJS**, supporting both **real-time communication** and traditional REST/GraphQL interactions. Built with microservices, gRPC, and WebSockets, it provides real-time chat, friend/follow systems, and a foundation for modern social features.\n\n---\n\n## 📌 Table of Contents\n\n* [Features](#features)\n* [Tech Stack](#tech-stack)\n* [Architecture](#architecture)\n* [Getting Started](#getting-started)\n* [Microservices Overview](#microservices-overview)\n* [Gateway API](#gateway-api)\n* [Authentication](#authentication)\n* [Real-time Communication](#real-time-communication)\n* [API Documentation](#api-documentation)\n* [Usage Examples](#usage-examples)\n* [Planned Features](#planned-features)\n* [Project Structure](#project-structure)\n* [Contributing](#contributing)\n* [License](#license)\n\n---\n\n## ✨ Features\n\n* 🧱 Microservices architecture with gRPC\n* 🌐 REST + GraphQL API support\n* 🔐 Auth system with JWT and RBAC\n* 🧑‍🤝‍🧑 Follow/friend request system\n* 💬 1-on-1 and group chat support with Socket.IO\n* 📥 Group join requests with admin approval\n* 📌 Real-time messaging using WebSockets\n* 🔔 Notification support (via Redis pub/sub)\n\n---\n\n## 🛠 Tech Stack\n\n| Layer             | Tech Used                               |\n| ----------------- | --------------------------------------- |\n| Backend Framework | NestJS                                  |\n| API Protocols     | REST, GraphQL, gRPC                     |\n| Real-time Engine  | WebSockets, Socket.IO                   |\n| Messaging Queue   | Redis Pub/Sub                           |\n| Database          | PostgreSQL                              |\n| Auth              | JWT, RBAC                               |\n| Containerization  | Docker, Docker Compose                  |\n| DevOps            | GitHub Actions (CI/CD), Terraform (WIP) |\n\n---\n\n## 🏗 Architecture\n\n\\[Insert system architecture diagram here: gateway, services, Redis, WebSockets, etc.]\n\n---\n\n## 🚀 Getting Started\n\n### Prerequisites\n\n* Node.js (v18+)\n* Docker \u0026 Docker Compose\n* PostgreSQL\n* Redis\n\n### Clone the Repo\n\n```bash\ngit clone https://github.com/iamarvy/social-media-api.git\ncd social-media-api\n```\n\n### Install Dependencies\n\n```bash\nnpm install\n```\n\n### Run with Docker\n\n```bash\ndocker-compose up --build\n```\n\n### Run Individual Services\n\n```bash\ncd services/auth\nnpm run start:dev\n```\n\n---\n\n## 🧩 Microservices Overview\n\n| Service              | Description                              |\n| -------------------- | ---------------------------------------- |\n| Auth Service         | Handles sign up, login, token generation |\n| User Service         | Stores user profile and connection data  |\n| Post Service         | Manages posts, comments, and likes       |\n| Chat Service         | Handles real-time and group messaging    |\n| Notification Service | Sends real-time or async notifications   |\n\n---\n\n## 🌐 Gateway API\n\n* Unified **REST and GraphQL** entry point for frontend clients\n* Integrates with all microservices over gRPC\n* Handles WebSocket connections for real-time communication\n* Includes role and token validation middleware\n\n---\n\n## 🔐 Authentication\n\n* Uses **JWT-based** auth across services\n* Role-based permissions: User, Admin, Group Admin\n* Token validation handled at gateway + gRPC level guards\n\n---\n\n## 🔄 Real-time Communication\n\n* WebSocket gateway powered by **Socket.IO**\n* Chat service emits and listens to events using Redis pub/sub\n* Group messaging with join requests and admin approval\n* Message persistence using PostgreSQL\n\n---\n\n## 📚 API Documentation\n\nThis project uses **Swagger** for automatic API documentation.\n\n* 🧭 **Full REST Docs**: Available at `http://localhost:3000/api`\n* ⚙️ **Generated via**: NestJS + Swagger module\n\n### Sample Endpoints\n\n| Method | Endpoint       | Description              |\n| ------ | -------------- | ------------------------ |\n| POST   | `/auth/signup` | Register a new user      |\n| POST   | `/auth/login`  | Authenticate and get JWT |\n| GET    | `/users/me`    | Fetch current user info  |\n| POST   | `/posts`       | Create a new post        |\n\n📌 For the complete list of endpoints, request/response schemas, and error formats, see the Swagger UI at `/api/docs`.\n\n---\n\n## 🧪 Usage Examples\n\n### Authentication\n\n```bash\ncurl -X POST http://localhost:3000/auth/login \\\n  -H 'Content-Type: application/json' \\\n  -d '{ \"email\": \"user@example.com\", \"password\": \"123456\" }'\n```\n\n### Create Post\n\n```bash\ncurl -X POST http://localhost:3000/posts \\\n  -H 'Authorization: Bearer \u003ctoken\u003e' \\\n  -H 'Content-Type: application/json' \\\n  -d '{ \"text\": \"My first post!\" }'\n```\n\n### Send WebSocket Message (via Socket.IO client)\n\n```js\nsocket.emit('send_message', {\n  roomId: 'abc123',\n  message: 'Hello, world!',\n});\n```\n\n---\n\n## 🛠 Planned Features\n\n* [ ] Story/Status system\n* [ ] Media uploads with storage microservice\n* [ ] Notification preferences \u0026 batching\n* [ ] Activity logs and admin moderation tools\n* [ ] Full-text post and comment search\n\n---\n\n## 📁 Project Structure\n\n```bash\n/services\n  ├── auth/\n  ├── users/\n  ├── posts/\n  ├── chat/\n  ├── notifications/\n  └── common/\n/gateway\n  ├── api-gateway/\n/proto\n  └── *.proto\n/docker\n  └── docker-compose.yml\n```\n\n---\n\n## 🤝 Contributing\n\n1. Fork this repo\n2. Create a branch (`git checkout -b feature/my-feature`)\n3. Commit your changes\n4. Push to your branch (`git push origin feature/my-feature`)\n5. Open a Pull Request\n\n---\n\n## 📄 License\n\nThis project is licensed under the MIT License.\n© 2025 Oluwaseyi Oke\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiamarvy%2Fnexlink","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fiamarvy%2Fnexlink","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiamarvy%2Fnexlink/lists"}