https://github.com/iamarvy/dreamscape
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.
https://github.com/iamarvy/dreamscape
docker event-driven-architecture grpc jwt kafka microservices nestjs nuxtjs typescript websockets
Last synced: 5 months ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/iamarvy/dreamscape
- Owner: iamArvy
- Created: 2025-05-13T14:45:30.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-05-13T15:03:08.000Z (5 months ago)
- Last Synced: 2025-05-13T16:25:49.130Z (5 months ago)
- Topics: docker, event-driven-architecture, grpc, jwt, kafka, microservices, nestjs, nuxtjs, typescript, websockets
- Language: TypeScript
- Homepage:
- Size: 7.6 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Dreamscape
**A scalable social media platform built with a microservices architecture.**
## 🧩 Overview
Dreamscape is a modern web application that allows users to:
- 📸 Post updates and media
- ❤️ Like and 💬 comment on posts
- 💬 Chat in real-time with friends and groups
- 👥 Connect with other users
It’s built with **NestJS** for the backend services and **Nuxt** for the frontend, following a clean and modular microservices approach for better scalability, maintainability, and developer experience.
---
## 🛠️ Tech Stack
| Layer | Technology |
|--------------|----------------|
| Frontend | Nuxt 3 |
| Backend | NestJS |
| Communication| gRPC, WebSockets, REST |
| Auth | JWT, Passport |
| Realtime | Socket.io / Redis pub-sub |
| Database | PostgreSQL / MongoDB (per service) |
| Messaging | AWS SQS / Kafka (event-driven) |
| Infrastructure | Docker, AWS ECS/Fargate or EC2, S3, CloudFormation |
---
## 🧱 Microservices
| Service | Description |
|-------------------|---------------------------------------------------------|
| **Auth Service** | Handles user registration, login, and JWT issuance |
| **User Service** | Manages user profiles, connections, and preferences |
| **Post Service** | CRUD operations for user-generated posts |
| **Interaction Service** | Handles likes, comments, and reactions |
| **Chat Service** | Real-time messaging with support for 1-1 and group chats |
| **Notification Service** | Sends alerts for new messages, likes, and more |
| **Media Service** | Handles file uploads (images, videos) to S3 |
| **Gateway API** | Acts as an entry point, routes requests to services |
---
## 🚀 Getting Started
### Prerequisites
- Node.js (v18+)
- Docker & Docker Compose
- pnpm (or npm/yarn)
- AWS CLI (for cloud deployment)
### Local Setup
```bash
# Clone the monorepo
git clone https://github.com/iamArvy/dreamscape.git
cd dreamscape
# Install dependencies
pnpm install
# Start all services
docker-compose up --build
```
Frontend (Nuxt) will be available at `http://localhost:3000`
Backend services will run on different ports inside Docker.
---
## 🧪 Running Tests
Each service contains its own tests.
```bash
# Example for auth service
cd services/auth
pnpm test
```
---
## 📦 Folder Structure
```
dreamscape/
├── frontend/ # Nuxt frontend
├── services/ # NestJS microservices
│ ├── auth/
│ ├── user/
│ ├── post/
│ ├── chat/
│ └── ...
├── gateway/ # API Gateway using NestJS
├── docker-compose.yml
└── README.md
```
---
## 📈 Future Plans
- Implement Redis caching
- Add search service (e.g., ElasticSearch)
- Add subscriptions & notifications (Web Push)
- Integrate admin dashboard
- Support media tagging and mentions
---
## 📝 License
MIT License – see [LICENSE](./LICENSE)
---
## 🙌 Acknowledgements
Inspired by platforms like **Facebook**, **Twitter**, and **Discord** – designed to be modular, scalable, and developer-friendly.