Please Chat

A chat application built on WebSocket

View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Key Features
  • Built With
• Getting Started
  • Installation
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

Please Chat is an application similar to WhatsApp Web/iMessage featuring a two column layout which has a list of friends and compose box on the left column, and chat history on the right.

Key Features

• The application lets you search for a friend and start a chat with him. The user interface is inspired from the iMessage application on the Mac OS.

• One can send a message and see the replies echoed in a typical message format. Switching between friends lets you instantly see the corresponding chat history.

• Error handling has been implemented where apt error messages are displayed (connection closure, network failure etc).

• There is a toggle to switch between the connection status (online/offline).

• The app has an object oriented architecture implementing encapsulation and all the global variables & functions are attributed to a single pleaseChat object.

Built With

The application has been developed using HTML, SCSS, JavaScript and jQuery.

A WebSocket echo service has been used to fetch the chats & acts as the connection layer.

For more information about jQuery, please visit the official docs.

• JQuery

Getting Started

To run the application, just open index.html in your browser.

Installation

1. Clone the repo

git clone https://github.com/nashcheez/please-chat.git

2. To run the application locally you will need to change the WebSocket connection from wss to ws. See why.

var websocket = new WebSocket("ws://echo.websocket.org/");

3. Open index.html

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the project
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

@nashcheez - nashcheez@gmail.com

Project Link: https://github.com/nashcheez/please-chat

Acknowledgements

• iMessage
• FromSuperheroes