https://github.com/toth2000/chatbit

A real-time chat room application built using ReactJs, NodeJs and ExpressJs
https://github.com/toth2000/chatbit

expressjs javascript nodejs reactjs socket-io

Last synced: 7 months ago
JSON representation

A real-time chat room application built using ReactJs, NodeJs and ExpressJs

• Host: GitHub
• URL: https://github.com/toth2000/chatbit
• Owner: toth2000
• License: mit
• Created: 2021-07-05T09:14:27.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-10-18T09:26:40.000Z (over 4 years ago)
• Last Synced: 2025-05-05T09:09:44.644Z (9 months ago)
• Topics: expressjs, javascript, nodejs, reactjs, socket-io
• Language: JavaScript
• Homepage: https://toth2000.github.io/chatBit
• Size: 2.97 MB
• Stars: 2
• Watchers: 2
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# ChatBit

A realtime chatroom app.

[Website](https://tothagata.me/chatBit/)

----

## Branches

  

  - `master` branch contains all ReactJs client side code

  - `server` branch contains all NodeJs and ExpressJs server side code

  - `development` branch is used to test breaking Pull Requests

  - `gh-pages` branch is used to deploy the react code of `master` branch using GitHub pages

## Requirements

For development, you will only need Node.js and ReactJs installed in your environement.

### Node

- #### Node installation on Windows

  Just go on [official Node.js website](https://nodejs.org/) and download the installer.

Also, be sure to have `git` available in your PATH, `npm` might need it (You can find git [here](https://git-scm.com/)).

- #### Node installation on Ubuntu

  You can install nodejs and npm easily with apt install, just run the following commands.

      $ sudo apt install nodejs

      $ sudo apt install npm

- #### Other Operating Systems

  You can find more information about the installation on the [official Node.js website](https://nodejs.org/) and the [official NPM website](https://npmjs.org/).

If the installation was successful, you should be able to run the following command.

    $ node --version

    v8.11.3

    $ npm --version

    6.1.0

If you need to update `npm`, you can make it using `npm`! Cool right? After running the following command, just open again the command line and be happy.

    $ npm install npm -g

---

## Install

    $ git clone https://github.com/toth2000/chatBit.git

    $ cd chatBit

    $ npm install

## Running the project

    $ npm start

## Simple build for production

    $ npm build

## Contribution guidelines

Please refer to our [Contribution Guide](https://github.com/toth2000/chatBit/blob/master/CONTRIBUTING.md) for contributing to this project. And remeber no contribution is small,  every contribution matters.