https://github.com/sushmitha-93/cmpe-275-stackoverflow-clone
https://github.com/sushmitha-93/cmpe-275-stackoverflow-clone
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/sushmitha-93/cmpe-275-stackoverflow-clone
- Owner: Sushmitha-93
- Created: 2023-09-03T01:48:46.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-09-10T00:58:58.000Z (over 1 year ago)
- Last Synced: 2025-01-23T16:51:22.172Z (4 months ago)
- Language: JavaScript
- Size: 1.78 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Distributed StackOverflow-Clone
This project is a clone of the Stack Overflow website, meticulously designed for distributed scalability. The backbone of our system is a robust backend seamlessly integrated with **Redis Cache**, ensuring rapid data retrieval and response times. To manage concurrent interactions effectively, we've implemented **Kafka** messaging, enabling smooth communication between various parts of the application. This combination of technologies creates a high-performance and scalable platform, **capable of handling a substantial user load with ease**.
## Table of Contents
- [Tech Stack](#tech-stack)
- [Heavyweight Resource Handling](#heavy-weight-resource-handling)
- [Object Management Policy](#object-management-policy)
- [Frontend](#frontend)
- [Backend](#backend)
- [Getting Started](#getting-started)
## Architecture Diagram
## Tech Stack
- **Frontend**: React.js
- **Backend**: Node.js, Express.js, Mongoose ORM
- **Database**: MongoDB, AWS S3, Redis
- **Message Queue**: Apache Kafka
- **Performance Testing**: JMeter, Grafana
- **Cloud Services**: AWS EC2, Load Balancer
- **Test Framework**: Mocha
## Heavy Weight Resource Handling
- S3 Bucket stores large data like images for faster access and scalability.
- Connection Pooling reduces database creation time and optimizes resource usage.
- Redis Caching accelerates frequently called database queries.
- Kafka Messaging Queue handles API calls, managing the request/response cycle.
- AWS Load Balancer distributes server load for better performance.
## Object Management Policy
- User, Post, Post_tag, Comment, Bookmark, Badge, Vote & Tag are implemented using SQL due to inter-dependencies and complex joins.
- Messages, PostHistory & ReputationHistory use MongoDB for historical and large data.
- MongoDB's document-centric approach handles large data with higher throughput, making it suitable for scaling.
## Frontend
- Axios is used for handling API requests to the backend.
- Redux manages state, aiding in performance optimizations.
- Rich text editors are implemented for posting questions, answers, and comments.
- React Bootstrap is used for styling.
- Pagination is implemented for user and post components.
- Graphical and visualization components are built using Chart.js in the Admin Dashboard.
## Backend
- Objects like User, Post, Post_tag, Comment, Bookmark, Badge, Vote & Tag are implemented using SQL due to inter-dependency and complex joins.
- MongoDB is used for historical data and large tables like Messages, PostHistory & ReputationHistory. MongoDB's document-centric approach is chosen for high throughput and scalability.
- JWT authentication is implemented for authorized API calls. Private routes are created for admin access only
## Getting Started
1. Clone the repository
2. Install dependencies in backend and frontend directories3.
4. Create MySQL database called stackoverflow
5. Start Kafka and Redis
6. Update connections in .env files in backend and frontend
7. npm start