Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/IgorAntun/node-chat

:speech_balloon: Chat application built with NodeJS and Material Design
https://github.com/IgorAntun/node-chat

chat nodejs websocket

Last synced: about 2 months ago
JSON representation

:speech_balloon: Chat application built with NodeJS and Material Design

Host: GitHub
URL: https://github.com/IgorAntun/node-chat
Owner: igorantun
License: mit
Created: 2015-03-18T01:48:13.000Z (almost 10 years ago)
Default Branch: master
Last Pushed: 2022-10-14T13:48:13.000Z (about 2 years ago)
Last Synced: 2024-01-25T07:08:11.095Z (11 months ago)
Topics: chat, nodejs, websocket
Language: JavaScript
Homepage:
Size: 795 KB
Stars: 752
Watchers: 40
Forks: 765
Open Issues: 14
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

fucking-awesome-readme - IgorAntun/node-chat - Project screenshot. Informative badges. Clear description. Easy installation/use instructions. Live demo. (Examples)
awesome-readme - IgorAntun/node-chat - Project screenshot. Informative badges. Clear description. Easy installation/use instructions. Live demo. (Examples)
awesome-readme - node-chat - Project screenshot. Informative badges. Clear description. Easy installation/use instructions. Live demo. (Examples)

README

        Node.JS Chat

============

[![GitHub Stars](https://img.shields.io/github/stars/IgorAntun/node-chat.svg)](https://github.com/IgorAntun/node-chat/stargazers) [![GitHub Issues](https://img.shields.io/github/issues/IgorAntun/node-chat.svg)](https://github.com/IgorAntun/node-chat/issues) [![Current Version](https://img.shields.io/badge/version-1.0.7-green.svg)](https://github.com/IgorAntun/node-chat) [![Live Demo](https://img.shields.io/badge/demo-online-green.svg)](https://igorantun.com/chat) [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/IgorAntun/node-chat?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

This is a node.js chat application powered by SockJS and Express that provides the main functions you'd expect from a chat, such as emojis, private messages, an admin system, etc.

![Chat Preview](http://i.imgur.com/lgRe8z4.png)

---

## Buy me a coffee

Whether you use this project, have learned something from it, or just like it, please consider supporting it by buying me a coffee, so I can dedicate more time on open-source projects like this :)



---

## Features

- Material Design

- Emoji support

- User @mentioning

- Private messaging

- Message deleting (for admins)

- Ability to kick/ban users (for admins)

- See other user's IPs (for admins)

- Other awesome features yet to be implemented

![User Features](http://i.imgur.com/WbF1fi2.png)

![Admin Features](http://i.imgur.com/xQFaadt.png)

#### There are 3 admin levels:

- **Helper:** Can delete chat messages

- **Moderator:** The above plus the ability to kick and ban users

- **Administrator:** All the above plus send global alerts and promote/demote users

---

## Setup

Clone this repo to your desktop and run `npm install` to install all the dependencies.

You might want to look into `config.json` to make change the port you want to use and set up a SSL certificate.

---

## Usage

After you clone this repo to your desktop, go to its root directory and run `npm install` to install its dependencies.

Once the dependencies are installed, you can run  `npm start` to start the application. You will then be able to access it at localhost:3000

To give yourself administrator permissions on the chat, you will have to type `/role [your-name]` in the app console.

---

## License

>You can check out the full license [here](https://github.com/IgorAntun/node-chat/blob/master/LICENSE)

This project is licensed under the terms of the **MIT** license.