Skip to content

Latest commit

 

History

History
54 lines (39 loc) · 1.64 KB

README.md

File metadata and controls

54 lines (39 loc) · 1.64 KB
Raw

Slick Chat

A simple real time chatting application built using WebSockets. Checkout some of the screenshots here!

About

The entire application is written in Typescript. We use React for the front end and Express for the backend. The database used is PostgresQL and Socket.IO is used for implementing WebSockets.

This is the currently hosted application's architecture:

App Arch

Features

Implemented

  • Chatting (duh)
  • Authentication (currently local)
  • Real time updates
  • Responsive
  • Infinite Scrolling for group chats
  • A robust API to allow front-ends for other platforms(like TUIs)
  • Home Page
  • A catchy name
  • Notification support

Setup

  • Install PostgreSQL.
  • Install Redis.
  • Clone the repository on your system.
  • Replace the following files with the configuration as you want and save them without the '.example' suffix: frontend env, server env and database env
  • Install deps and start the server by:
cd server
npm install
npm run dev
  • Install deps and start the frontend dev server in another terminal tab by:
cd front-end
npm install
npm start

Contributors