Skip to content

DeezChat App, a Real-Time Chat built using Vanila.js, Node.js, Express.js, WebSocket, MongoDB and implemented RBAC with JWT, Api docs by Swagger, Unit Testing by Jest.

Notifications You must be signed in to change notification settings

RevoU-FSSE-2/week-11-muhammad-avicena

Repository files navigation

header

Fancy to see you here

hi, I'm Muhammad Avicena. In this repo, I build a Real Time Chat application implemented role-based access using Vanila.js, Node.js, Express.js, Socket.io, MongoDB, Jest and Swagger. It's designed to interact with each other like group chat. If you have any question or feedback, hit me up at anytime !

I am committed to staying up-to-date with industry trends and using the latest tools to develop innovative solutions that surpass expectations. Interested to have collaboration ? Find me on:

Linkedin Badge Youtube Badge Instagram Badge Gmail Badge

INGREDIENTS I USE 📜

  • WebClient
    • Vanila JS
    • Tailwind CSS
  • WebServer
    • Node.js
    • Express.js
    • JWT for Role-Based Access Controll
    • WebSocket/Socket.io for Real Time Connection
    • MongoDB
  • Unit Testing
    • Jest
  • API Documentation
    • Swagger UI

ARCHITECTURE 🌟

arch

HOW TO SET UP 📰

You will need a github account to clone this repository, make sure you're connected to github.

# Clone this repository or simply fork it.

- git clone https://github.com/muhammad-avicena/deez-chat-app.git

# Install depedencies

- npm install

# Set up the .env file, follow the template from `.env.example`.

  # PORT
  PORT=5001

  ## Database connection
  DB_PROD=
  DB_DEV=
  DB_NAME=

  ## JWT Sign
  JWT_SIGN=

# Run the application

- npm run start
- npm run dev

AVAILABLE API 📰

Endpoint : https://deezchat.avicena.dev

Name HTTP Method Endpoint Requirements
Login User POST /api/v1/auth/login Request Body: username: string, password: string
Register User POST /api/v1/auth/register Request Body: username: string, password: string, gender: string
List All User GET /api/v1/users
List User by ID GET /api/v1/users/:id Request Params: id: number
Update User role PATCH /api/v1/users/role/:id Request Params: id: number Request Body: role: string
List All Rooms GET /api/v1/rooms
Create a room POST /api/v1/rooms Request Body: roomName: string, username: string
Delete Room by ID DELETE /api/v1/rooms/:id Request Params: id: number
User Join POST /api/v1/participants Request Body: roomName: string, username: string
Get User Join GET /api/v1/participants?roomName={roomName}&username={username} Request Query: roomName: string, username: string
Get User Join by RoomName GET /api/v1/participants/list?roomName={roomName} Request Query: roomName: string
User Leave DELETE /api/v1/participants Request Body: username: string

Swagger UI - API Documentation and Testing ⚡

Detail documentation will be shown here : https://deezchat.avicena.dev/api-docs swagger

DEPLOYMENT ⚙️

Alt text

The project has been successfully deployed using Railway. You can access the production version of the website by following this link: https://deezchat.avicena.dev.

Feel free to explore the website and try out the different features. I appreciate any feedback and suggestions to further improve the user experience.

About

DeezChat App, a Real-Time Chat built using Vanila.js, Node.js, Express.js, WebSocket, MongoDB and implemented RBAC with JWT, Api docs by Swagger, Unit Testing by Jest.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published