Chat Application

A simple client-server chat application built on React, Redis and Socket.io.
Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

I've always wanted to build a simple client-server chat application, as I'm interested in the way that sockets work both from a technical standpoint and from a user experience standpoint.

Additionally, I've always wanted to build an SPA using React, and haven't had the chance to until now, so this is my first attempt at building a React app and using Redis for storage.

(back to top)

Built With

• 
• 
• 

(back to top)

Getting Started

Follow these instructions to set up the application on your machine.

Build it yourself

1. Clone the repo

   git clone https://github.com/kingsthwaiteJ/chat-app.git
   

2. Install NPM packages

   npm install
   

3. Run the application

   node index.js
   

(back to top)

Usage

After this extension has been added to chrome, there is no further set up required. Whenever you open a new tab and click on the extension icon from your extensions bar, the popup will appear with the JSON-LD content of the active page.

You can then browse through the content using the embedded JSON viewer, or copy the JSON-LD content and review it in another application.

(back to top)

Roadmap

• Migrate to Typescript ✅
• Add test framework + implement tests
• Implement React + UI improvements
• Implement Redis for persistent storage (sqlite as a backup)
• Add the ability to engage in multiple chat rooms concurrently
• Implement direct message functionality with another user

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

(back to top)

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/featureName)
3. Commit your Changes (git commit -m 'Added a new feature')
4. Push to the Branch (git push origin feature/featureName)
5. Open a Pull Request

(back to top)

License

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

(back to top)

Acknowledgments

Thank you to the following package owners:

• Socket.io for providing a fantastic socket library.

(back to top)