YoungMind1 / chat-app

A university web project

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Real-Time Chat App using React, ContextAPI, Node.js and Socket.io

Description

This is a real-time chat app built using React, ContextAPI, Node.js and Socket.io. The app allows users to register, log in, and start chatting with other users in real-time. This project is the final project for the course "Web Development" of Urmia University in Fall 2023 which is taught by Dr. Asgharian.

Installation

To install the app, follow these steps:

  1. Clone the repository.
  2. Install the dependencies using npm install.
  3. Set the required environment variables.
  4. Start the server using npm start.

Usage

To use the app, follow these steps:

  1. Register for an account.
  2. Log in to your account.
  3. Start chatting with other users.

API Documentation

Authentication APIs

  • Node.js Authentication API
  • Protecting Route
  • Login User
  • Logout User
  • Register User

Chat APIs

  • Chat APIs
  • Fetch Chats
  • List Chats
  • Create Chats

Messages APIs

  • Get Messages
  • Send Messages

Contributing

To contribute to the project, follow these steps:

  1. Submit a bug report or feature request.
  2. Fork the repository.
  3. Create a new branch.
  4. Make your changes.
  5. Submit a pull request.

Credits

This project was built by:

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

About

A university web project

License:MIT License


Languages

Language:JavaScript 89.5%Language:CSS 9.4%Language:HTML 1.1%