ChatBit

A realtime chatroom app. Website

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 and download the installer. Also, be sure to have git available in your PATH, npm might need it (You can find git here).

• 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 and the official NPM website.

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 for contributing to this project. And remeber no contribution is small, every contribution matters.