https://github.com/cristianprochnow/synchat
:speech_balloon: A simple and practical chat project.
https://github.com/cristianprochnow/synchat
chat nodejs react socket-io
Last synced: 3 months ago
JSON representation
:speech_balloon: A simple and practical chat project.
- Host: GitHub
- URL: https://github.com/cristianprochnow/synchat
- Owner: cristianprochnow
- License: mit
- Created: 2020-04-02T03:36:30.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-12-15T22:17:04.000Z (over 5 years ago)
- Last Synced: 2025-02-02T13:15:31.898Z (over 1 year ago)
- Topics: chat, nodejs, react, socket-io
- Language: JavaScript
- Homepage:
- Size: 8.72 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
A simple and practical web chat.
Explore the docs »
Report Bug
·
Request Feature
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![Repo Size][repo-size-shield]][repo-size-url]
[![Code Size][code-size-shield]][code-size-url]
[![MIT License][license-shield]][license-url]
📚 Table of Contents
* [About the Project](#about-the-project)
* [Built With](#built-with)
* [Getting Started](#getting-started)
* [Prerequisites](#prerequisites)
* [Installation](#installation)
* [Usage](#usage)
* [Contributing](#contributing)
* [License](#license)
* [Contact](#contact)
📖 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](https://github.com/facebook/react) technology
🔧 Built With
* [React](https://github.com/facebook/react)
* [Express](https://github.com/expressjs/express)
* [Socket.io](https://github.com/socketio/socket.io)
🚀 Getting Started
📝 Prerequisites
* [Node.js](https://nodejs.org/en/download/package-manager/)
⚙️ Installation
1. Clone this repository
```sh
git clone https://github.com/cristianprochnow/Synchat.git
```
2. Install all the packages and dependencies
```sh
# If you are using NPM
npm install
# Or then, if you are using Yarn
yarn
```
3. Enter in `backend` and then in `frontend` folders, and start the servers
```sh
# If you are using NPM
npm start
# Or then, if you are using Yarn
yarn start
```
4. 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][linkedin-shield]][linkedin-url]
Project Link: [https://github.com/cristianprochnow/Synchat](https://github.com/cristianprochnow/Synchat)
[contributors-shield]: https://img.shields.io/github/contributors/cristianprochnow/Synchat.svg?style=flat
[contributors-url]: https://github.com/cristianprochnow/Synchat/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/cristianprochnow/Synchat.svg?style=flat
[forks-url]: https://github.com/cristianprochnow/Synchat/network/members
[stars-shield]: https://img.shields.io/github/stars/cristianprochnow/Synchat.svg?style=flat
[stars-url]: https://github.com/cristianprochnow/Synchat/stargazers
[issues-shield]: https://img.shields.io/github/issues/cristianprochnow/Synchat.svg?style=flat
[issues-url]: https://github.com/cristianprochnow/Synchat/issues
[license-shield]: https://img.shields.io/github/license/cristianprochnow/Synchat.svg?style=flat
[license-url]: https://github.com/cristianprochnow/Synchat/blob/master/LICENSE.txt
[repo-size-shield]: https://img.shields.io/github/repo-size/cristianprochnow/Synchat.svg?style=flat
[repo-size-url]: https://github.com/cristianprochnow/Synchat
[code-size-shield]: https://img.shields.io/github/languages/code-size/cristianprochnow/Synchat
[code-size-url]: https://github.com/cristianprochnow/Synchat
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat&logo=linkedin&colorB=0077b4
[linkedin-url]: https://www.linkedin.com/in/cristianprochnow