https://github.com/joshuadeguzman/chatify
A simple chat app created with socket.io
https://github.com/joshuadeguzman/chatify
chat expressjs nodejs websocket
Last synced: 4 months ago
JSON representation
A simple chat app created with socket.io
- Host: GitHub
- URL: https://github.com/joshuadeguzman/chatify
- Owner: joshuadeguzman
- Created: 2018-03-02T07:10:27.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-03-08T09:47:48.000Z (over 8 years ago)
- Last Synced: 2026-02-16T15:28:06.228Z (4 months ago)
- Topics: chat, expressjs, nodejs, websocket
- Language: CSS
- Homepage:
- Size: 1.33 MB
- Stars: 1
- Watchers: 1
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Chatify
A simple chat app created with socket.io
## Features
- [x] Realtime chat
- [x] Client Id/Nickname saving
- [x] Lightweight
- [x] Responsive UI
## Prerequisites
- [NodeJS](https://nodejs.org/en/) - is a JavaScript runtime built on Chrome's V8 JavaScript engine. Node.js uses an event-driven, non-blocking I/O model that makes it lightweight and efficient.
Node.js' package ecosystem, npm, is the largest ecosystem of open source libraries in the world.
- [SocketIO](https://socket.io/) - Socket.IO enables real-time bidirectional event-based communication.
It works on every platform, browser or device, focusing equally on reliability and speed.
- [ExpressJS](https://expressjs.com/) - is a minimal and flexible Node.js web application framework that provides a
robust set of features for web and mobile applications.
- Optional tools
- **[ngrok](https://ngrok.com/) -** a secure introspectable tunnels to localhost webhook development tool and debugging tool.
- **[Inspinia Theme](https://github.com/Chuibility/inspinia) -** is a premium admin dashboard template with flat design concept. It is fully responsive admin dashboard template built with Bootstrap 3+ Framework, HTML5 and CSS3, Media query.
## Installation
### NodeJS
- Binaries, installers, and source tarballs are available at https://nodejs.org.
### Socket.IO
```bash
$ npm install socket.io
```
### ExpressJS
```bash
$ npm install express --save
```
> To install only for dev environment
```bash
$ npm install express --dev
```
Then, run the following command:
```bash
$ node server.js
```
### ngrok (optional)
Go to their website, and download the client application https://ngrok.com/download.
```bash
$ unzip /path/to/ngrok.zip
```
#### Start it up
Read the [documentation](https://ngrok.com/docs/2) on how to use ngrok. Try it out by running it from the command line:
```bash
$ ./ngrok help
```
To start a HTTP tunnel on port 8000, run this next:
```bash
$ ./ngrok http 8000
```
Then, serve it, copy the generated url, share it with your friends.
## Examples
See [Screenshots](https://github.com/devjdg/chatify/tree/master/Screenshots)
## License
Chatify is under the [Creative Commons License 3.0](https://creativecommons.org/licenses/by/3.0/)