Skip to content

An easy-to-use API for building chat applications with real-time messaging and chat rooms

Notifications You must be signed in to change notification settings

sm0483/ghostchats-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Chat API

Chat API is a simple chat application that enables users to send and receive messages in real-time. The app utilizes Socket.io for real-time communication and provides support for multiple chat rooms, allowing users to participate in group conversations.

Features

  • Real-time messaging: Users can send and receive messages instantly using WebSockets.
  • Chat rooms: Users can join different chat rooms to engage in group conversations.
  • Room IDs: Users can retrieve a list of available room IDs to join.

Getting Started

Follow the steps below to get started with the Chat API:

Prerequisites

  • Node.js and npm should be installed on your system.

Installation

  1. Clone this repository to your local machine:

  2. Navigate to the project directory:

  3. Install the dependencies:

Usage

Development Mode

To run the application in development mode, use the following command:

npm i && npm run start:dev

The application will be available at http://localhost:{PORT}.

Production Build

To build and run the application in production mode, follow these steps:

npm i && npm start

The application will be available at http://localhost:{PORT}.

Running with Docker

To run the application in a Docker container, follow these steps:

docker build -t ghost-api . && docker run -p 5000:5000 ghost-api

The application will be accessible at http://localhost:5000.

About

An easy-to-use API for building chat applications with real-time messaging and chat rooms

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published