Realtime Chat App Backend

The server side of a web-based messaging application that delivers messages instantaneously.

View Live Demo »

View Video Demo »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contact

About The Project

Built With

• React
• Socket.io
• Typescript
• Node.js
• MongoDB

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

Install latest version of npm

• npm

  npm install npm@latest -g

Installation

1. Clone the project

   git clone https://github.com/crookedfingerworks/chat-backend.git

2. Go to project directory and Install NPM packages

   npm install

3. Create config.env file and specify values for the ff.

   PORT, DATABASE_URL, SECRET_KEY

4. Start the application

   npm run dev

Usage

Creating an Account

1. In the login page, click 'Register here'.
2. Input the necessary fields. Don't worry. It won't take long.
3. You'll be redirected to the login page. Enter your newly created credentials.

Creating a Room

1. Click the message icon on the sidebar header.
2. Inputing the necessary fields.
3. Share the randomly-generated room code with people you want to invite in the room.

Joining a Room

1. Obtain the room code from the room creator.
2. Click the message icon on the sidebar header.
3. Click 'Join Room' tab option.
4. Input room code and proceed.

Contact

crooked.finger.works@gmail.com

Project Link: https://github.com/crookedfingerworks/chat-backend