Skip to content

farik92/b2b-community

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Real Time Chat

This project is a real-time chat created to demonstrate my fullstack skills and communication with websockets.

Technologies

  • Backend

    • NestJS: node.js framework
    • Socket.io: real time comunication
    • MySQL: database
  • Frontend

    • React: javascript framework

Main features

  • Real Time Messaging: Users can send and receive messages instantly thanks to Socket.io integration.
  • User Management: User registration and authentication for a personalized and secure chat.
  • Profile Images: Creation and update of image for the user profile.
  • Chat Rooms: Ability to create different chat rooms, facilitating organized conversations.

Environment Variables

Backend

  • Open BackEnd folder

    cd BackEnd
    
  • Copy the ".env.example" file to ".env"

    cp .env.example .env
    
  • Finally open the ".env" file and set the required variables.

Frontend

  • Open FrontEnd folder

    cd FrontEnd
    
  • Copy the ".env.example" file to ".env"

    cp .env.example .env
    
  • Finally open the ".env" file and set the required variables. (variables should start with "VITE")

Installation

git clone https://github.com/farik92/b2b-community.git
cd b2b-community
npm install
npm run dev

API Documentation

This project uses Swagger to generate the API documentation. Swagger provides a interface to explore and test the API endpoints.

Accessing the API Documentation

  • Ensure the backend server is running.
  • Open your web browser and navigate to the following URL: http://localhost:3000/api-docs
  • You should see the Swagger UI with the complete documentation of the API.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published