Skip to content

Latest commit

 

History

History
67 lines (44 loc) · 1.45 KB

README.md

File metadata and controls

67 lines (44 loc) · 1.45 KB

React Chat Application

Live Demo

Since the demo is hosted on a free Heroku account, the servers its hosted on enter ‘sleep mode’ when not in use. If you notice a delay, please allow a few seconds for the servers to wake up.

Description:

This is a real-time chat application built using React (Create React App on the frontend) and NodeJS/Express/Socket.io Backend. Users are able to join groups and message other users in real-time.

Tech Stack

  • NodeJS/Express
  • Socket.io
  • React
  • React Router
  • Moment JS
  • SASS

Development Details

Before proceeding, please ensure you have the following software installed on your computer.

  • Node
  • Yarn (optional but recommended)
  • Git command line tools

Download & Install Dependencies on your machine

Clone the repo to your machine

git clone <CloneURL>

Lunch the backend

  1. Within terminal or cmd ensure you have navigated inside the 'server' directory and installed the dependencies
cd <../path/to/server>
yarn install OR npm install
  1. Run the start script
yarn run start OR npm run start

Lunch the frontend

  1. Open a new terminal window and navigate inside the 'client' folder as you will need to keep the backend running in the background
cd <../path/to/client>
yarn install OR npm install
  1. Run the start script
yarn run start OR npm run start

Your app should be running on: http://localhost:3000