Skip to content

viral32111/LiveChat

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Live Chat

CI CodeQL GitHub tag (with filter) GitHub repository size GitHub release downloads GitHub commit activity

This is a real-time, ephemeral, room-based chat system, housed in a dynamic & modern web application.  

Screenshot

📥 Usage

Deployment History

Alternatively you can run it locally by using the official Docker image. You will need to set all the required environment variables (see production.env).

🏗️ Development

This assumes you have a MongoDB server already up and running.

  • Clone this repository (git clone https://github.com/viral32111/LiveChat.git)
  • Switch to the server directory (cd ./Server)
  • Install production & development dependencies (npm install)
  • Setup up development.env & test.env environment variables files (copy production.env and configure appropriately).
  • Run unit & integration tests (npm test).
  • Start project (npm start)

✔️ Progress

See the Kanban board, issues and milestones for tracking the project's progress.

⚖️ License

Copyright (C) 2022-2023 viral32111.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses.