README.md

Chat-App

This is a simple chat application built using Socket.IO for real-time messaging. It allows users to register, login, and communicate with each other in real-time.

Tech Stack

• Frontend: HTML, CSS, JavaScript, React
• Backend: Node.js, Express
• Database: MongoDB
• Real-time Communication: Socket.IO

Features

• User Registration: Users can register by providing their name, email, password, mobile number, and address details.
• User Login: Registered users can login using their email and password.
• Real-time Messaging: Users can send and receive messages in real-time.
• User List: Users can view a list of other users currently online and select a user to chat with.
• User Details: Users can view details of other users, including their mobile number and address, by clicking on their email.

Getting Started

1. Clone the repository.
2. Install dependencies using npm install.
3. Start the server using npm start.
4. Access the application in your browser at http://localhost:3000.

Endpoints

1. User Registration:
   • Endpoint: POST /user/register
   • Description: Registers a new user with the provided details.
   • Example:
     

               {
                 "name": "John Doe",
                 "email": "john@example.com",
                 "password": "password123",
                 "lastName": "Doe",
                 "mobileNo": "1234567890",
                 "address": {
                   "street": "123 Main St",
                   "city": "City",
                   "state": "State",
                   "country": "Country"
                 }
               }
             

2. User Login:
   • Endpoint: POST /user/login
   • Description: Logs in a user with the provided email and password.
   • Example:
     

               {
                 "email": "john@example.com",
                 "password": "password123"
               }
             

3. Get User Details by Email:
   • Endpoint: GET /user/:email
   • Description: Retrieves the details of a user by their email address.

Image

Note

This is a basic implementation and may require further enhancements for production use. Ensure to configure the application with your MongoDB database URI .

Authors

Manshi (github.com/manshikumari12))

Acknowledgements

This project was developed as part of a learning exercise in web development.