Skip to content

Latest commit

 

History

History
102 lines (65 loc) · 2.55 KB

README.md

File metadata and controls

102 lines (65 loc) · 2.55 KB

ChattyChan

ChattyChan a real-time, scalable chat application enabling users to send and receive messages instantly using modern full-stack technologies. Implemented cloud-native DevOps practices for seamless deployment, CI/CD automation, and high availability with load balancing.

chattychan

Build With 🛠️

  1. Frontend: React.js (with Socket.io for real-time communication)
  2. Backend: Node.js + Express.js (RESTful API & Socket.io integration)
  3. Database: PostgreSQL (relational structure) + Prisma ORM (type-safe queries)
  4. Backend-as-a-Service: Supabase (real-time database & authentication)

Cloud/DevOps Practices ☁️

  1. Git for version control
  2. Docker for containerized microservices architecture
  3. GitHub Actions CI/CD pipelines for pushing building and pushing the docker images to dockerhub
  4. Jenkins CI/CD pipline for deployment.
  5. AWS Cloud Platform
  6. Terraform (IaC) for provisioning cloud resources on AWS
  7. Kubernetes (EKS) for orchestration and auto-scaling
  8. Prometheus + Grafana (monitoring, alerting, and dashboard visualization)

Installation on Local Machine

How to run the Frontend

Navigate to frontend

cd frontend

Install dependencies

npm install

Run the frontend server

npm run dev

The Frontend is build with Vite so it'll run on http://localhost:5173

How to run the Backend

Navigate to backend

cd backend

Install dependencies

npm install

Run the backend server

npm run dev

The Backend will run on http://localhost:5001

Installation Using Docker 🐳

Install the Docker Desktop in your local machine

Because we need Docker Engine/Daemon to run the docker containers

After cloning the repository, open the terminal in the root directory(which is chattychatn) and run the below command:

docker compose up --build

Contributing 🤝

Open to collaborations! Check out our Contributing Guidelines to get started.

License 📜

MIT Licensed. See LICENSE for details.

⭐ Star the Repo! ⭐

Love this project? Show your support by starring the repository it helps the community discover this tool!