Skip to content

Latest commit

 

History

History
191 lines (142 loc) · 5.84 KB

README.md

File metadata and controls

191 lines (142 loc) · 5.84 KB
Raw

Logo

A simple and practical web chat.
Explore the docs »

Report Bug · Request Feature

Contributors Forks Stargazers Issues Repo Size Code Size MIT License


📚 Table of Contents


📖 About The Project


Since I started to programming with JavaScript, the real time interactions of this language impress me. And then, I met with a technology like websocket.js, that encouraged me to make this chat.

Here's why:

  • Test functionalities like "real time"
  • Apply some concepts about React technology

🔧 Built With


🚀 Getting Started

📝 Prerequisites

⚙️ Installation

  1. Clone this repository
  git clone https://github.com/cristianprochnow/Synchat.git
  1. Install all the packages and dependencies
  # If you are using NPM
  npm install

  # Or then, if you are using Yarn
  yarn
  1. Enter in backend and then in frontend folders, and start the servers
  # If you are using NPM
  npm start

  # Or then, if you are using Yarn
  yarn start
  1. A page in web will be available after the initialization of frontend server. If not, go to browser and search http://localhost:3000

💡 Usage

It's simple. First, start typing the name that you wish in the username field. And then, enjoy the chat sending messages, typing several types of text in message field.


Open other tabs of browser with the same address (http://localhost:3000) to see chat in action


🔗 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. 👯 Clone this project (git clone https://github.com/cristianprochnow/Synchat.git)
  3. 🔀 Create your Feature Branch (git checkout -b my-feature)
  4. ✔️ Commit your Changes (git commit -m 'feat: My new feature')
  5. 📌 Push to the Branch (git push origin my-feature)
  6. 🔁 Open a Pull Request

📜 License

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


📞 Contact

Cristian Prochnow - LinkedIn

Project Link: https://github.com/cristianprochnow/Synchat