Skip to content

Commit

Permalink
Updated Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sranmanpreet committed Aug 22, 2020
1 parent a878b14 commit 98e4de3
Show file tree
Hide file tree
Showing 3 changed files with 65 additions and 1 deletion.
65 changes: 65 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# Live Chat

A scalable real time chat application built in Angular, NodeJs, Express, Socket.io. Any number of users can come and chat in a chat room. Socket.io module takes care of web socket management.

![Application Screenshot 1](https://github.com/sranmanpreet/live-chat/blob/master/live-chat-client/src/assets/LiveChat.png?raw=true)

# Features!
- Chat Rooms
- One to One Chat
- Responsive Layout
- Scalable

### Tech
Application uses following of open source projects to work properly:

* [Angular] - A Javascript Framework by Google!
* [Bulma] - CSS framework based on Flexbox and built with Sass
* [node.js] - A set of behavior primitives for building UI components
* [Express] - fast node.js network app framework
* [Socket.io] - A JavaScript library for realtime web applications

### Installation

Live Chat requires [Node.js](https://nodejs.org/) v4+ to run.

Install the dependencies and devDependencies and start the server.

```sh
$ cd live-chat-server
$ npm install
$ node app
```

Install the dependencies and devDependencies and start the client.

```sh
$ cd live-chat-client
$ npm install
$ ng serve -o
```

## License
----

MIT


**Suggestions/Improvements are welcome. Want to develop together? You are most welcome.**

[//]: # (These are reference links used in the body of this note and get stripped out when the markdown processor does its job. There is no need to format nicely because it shouldn't be seen. Thanks SO - http://stackoverflow.com/questions/4823468/store-comments-in-markdown-syntax)


[Angular]: <https://angular.io/>
[git-repo-url]: <https://github.com/joemccann/dillinger.git>
[john gruber]: <http://daringfireball.net>
[df1]: <http://daringfireball.net/projects/markdown/>
[markdown-it]: <https://github.com/markdown-it/markdown-it>
[Ace Editor]: <http://ace.ajax.org>
[node.js]: <http://nodejs.org>
[Twitter Bootstrap]: <http://twitter.github.com/bootstrap/>
[Socket.io]: <https://socket.io/>
[Angular Material CDK]: <https://material.angular.io/cdk/categories>
[express]: <http://expressjs.com>
[AngularJS]: <http://angularjs.org>
[Bulma]: <https://bulma.io/>
1 change: 0 additions & 1 deletion live-chat-client/src/app/app.component.scss
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,6 @@
font-size: 0.8rem;
.status-value {
font-weight: 600;
font-size: 1.1rem;
color: $primary;
}
}
Expand Down
Binary file added live-chat-client/src/assets/LiveChat.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 98e4de3

Please sign in to comment.