utkarshahuja2003 / chat

Web Chat App using Next, Node and Socket-io

                   

Chat-App

This is a chat app made using Nextjs,TypeScript, Node and Socket.io

Features

• User can join Chat Room by entering their name
• Multiple Users can join the chat room and start chatting
• Sender's username and timestamp visible with every message

This project utilizes ESLint for code quality maintenance. Ensure coding standards by following the recommended formatting guidelines.

Installation

Clone the repository:

git clone https://github.com/UtkarshAhuja2003/chat.git

Navigate to the project folder:

cd chat

Backend

1. Install dependencies in root folder

npm install

2. Copy sample env to .env

cp .env.sample .env

Change URL and port if changed in frontend 3. Start the server

npm start

4. Check lint errors

npm run lint

Frontend

1. Navigate to client directory

cd client

2. Install dependencies in client

npm install

2. Copy sample env to .env

cp .env.sample .env

3. Start the nextjs app in development

npm run dev

4. Check lint errors

npm run lint

Now your Project is ready to run.

File Structure

.
├──src # backend 
    ├── controllers # route controller
    ├── routes # Custom routes
    ├── socket # Socket Initialisation
    ├── validators
    ├── utils # Misc tools and stuffs
    │   ├── APIError
    │   ├── Async Handler
    │   └── APIResponse
    ├── app.js
    ├── index.js # entry file 
    └── constant.js
└── client # frontend directory
    ├── src
    │   ├── api
    │   ├── app
    │   │    ├── chat #page
    │   │    └── login #page
    │   ├── components
    │   │     ├── Connection
    │   │     └── Message
    │   ├── context
    │   ├── interfaces
    │   └── utils # Misc tools and stuffs
    └── public

Screenshots

Demo Video

chat-app.mp4