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.
- 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.
Follow the steps below to get started with the Chat API:
- Node.js and npm should be installed on your system.
-
Clone this repository to your local machine:
-
Navigate to the project directory:
-
Install the dependencies:
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}
.
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}
.
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
.