davidgatti / theChat

πŸ—£ A simple chat app done in NodeJS, SocketIO and HTML

Home Page:https://david.gatti.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

The Chat

A simple πŸ—£ system to have some fun with Socket.io

Where to run

This project was designed to run in a Unix or Linux system. If you use Windows, I'm sorry but I have no idea how to go about making it work on that system. I'm open to any PR to fix this :)

How to run the project in production

This project is deployed on Heroku, and the the-chat.html is pointing to that external server, meaning you can start chatting with your friends right away.

How to run the project locally

  1. you need ot have Redis on your machine to make this work.
  2. you need to create a .env file, either by hand - check out the app.json to find out which variables are needed. Or you can install env-auto and use that simple tool to auto generate the .env file for you. Some edits might be required.
  3. type npm install to install all the necessary modules
  4. type npm run to start the server
  5. open the the-chat.html file and have fun with your friends

What to expect

  1. The front end is very basic, to let you focus on the solution itself, and not on my bad design taste ;)
  2. The chat app requires you to type a name before you can start chatting
  3. Some bogus historical data will be shown in the chat app, to make it look like someone was there before you ;)
  4. The app will also reorder the conversation history no matter in which order the messages come in.

How to run the test

  1. Start the server in another terminal window.
  2. Type npm test, and keep your finger cross 🀞.

WARNING: some IP and port changes may apply.

The End

If you enjoyed this project, please consider giving it a 🌟. And check out my GitHub account, where you'll find additional resources you might find useful or interesting.

Sponsor 🎊

This project is brought to you by 0x4447 LLC, a software company specializing in building custom solutions on top of AWS. Follow this link to learn more: https://0x4447.com. Alternatively, send an email to hello@0x4447.email.

About

πŸ—£ A simple chat app done in NodeJS, SocketIO and HTML

https://david.gatti.io

License:MIT License


Languages

Language:JavaScript 53.2%Language:HTML 46.8%