Skip to content

Atkinss1/chatApp

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

78 Commits
 
 
 
 
 
 

Repository files navigation

Chat Application README

Introduction

Welcome to the Chat Application! This project is a simple real-time chat application built using Node.js, Express, and Socket.io. It provides a platform for users to engage in real-time conversations, making it an ideal project for learning and experimenting with websockets.

Features

  • Real-time messaging using Socket.io
  • Simple and intuitive user interface
  • Easy setup and configuration
  • Scalable and extendable for further customization

Screenshots

screenshot screenshot screenshot screenshot

Prerequisites

Before you begin, make sure you have the following installed on your machine:

Installation

  1. Clone this repository:

    git clone git@github.com:Atkinss1/chatApp.git
  2. Navigate to the project directory:

    cd chatApp
  3. Install dependencies:

    npm install

Configuration

  1. Open the index.js file in a text editor of your choice.

  2. Locate the following line of code on line 29:

    const io = new Server
  3. Update the socket address to your server's address or localhost if running locally:

    const io = new Server(expressServer, {
        cors: {
            origin: 'http://your-server-address:your-port',
            methods: ['GET', 'POST'],
        },
    });
  4. Open the app.js file in a text editor of your choice.

  5. Locate the following line of code on line 4 and update the socket address to your server's address or localhost if running locally:

     const socket = io('http://your-server-address:your-port');

Usage

  1. Start the server:

    npm start
  2. Open your web browser and navigate to http://your-server-address:your-port.

  3. Enter a username and room, then start chatting!

License

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

  • This project was inspired by the need for a basic real-time chat application for learning purposes.

Feel free to reach out if you have any questions or need further assistance. Happy chatting!

About

Learning how to create a chat application using Node.js, Express and Socket.io

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published