README.md

codachat - A real time chatting application 📰

Go visit the website here and chat with your friends in real time!

Have a peek at the codachat web application 🧐

---

Features 🎊

• Fully responsive website. Fully functional mobile and desktop view.
• Client side HTML5, CSS3 and JavaScript
• Server side NodeJS, socket.io

The client side of the website is exposed at https://codachat-server.herokuapp.com/

---

Getting started 🎉

By following the instructions you can get a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites 📄

Your local machine must have Git and Node.js (which basically comes with NPM) installed.

node@v14.15.11 or higher
npm@6.14.11 or higher
git@2.31.1 or higher

---

Let's see how to use? 🛠

Open your git bash in the required directory and first clone this repository-

# Clone this repository and the server repository
$ git clone https://github.com/codadept/codachat
$ git clone https://github.com/codadept/codachat-server

# First go into the server repository
$ cd codachat-server

# Remove current origin repository
$ git remote remove origin

Then install the dependencies using NPM-

# Install dependencies
$ npm install

# Start development server
$ npm start

# Once your server has started, now go to the codachat repository:
$ cd codachat

# Remove current origin repository
$ git remote remove origin

Open index.html using your favourite code editor and modify the script tag as such

<script src="http://localhost:8000/socket.io/socket.io.js"></script>

instead of

<script src="https://codachat-server.herokuapp.com/socket.io/socket.io.js"></script>

And then open app.js and modify the line

const socket = io('https://codachat-server.herokuapp.com/');

to

const socket = io('http://localhost:8000/');

Now open index.html in your favourite browser and enjoy the experience of the live chat app!

---

Technologies used ⚙

• HTML5
• CSS3
• JavaScript
• Node.js
• socket.io

Authors 👨

• Pratik Majumdar (codadept) - https://github.com/codadept

Acknowledgments 😃

I was motivated to make this website as a way of learning more. The concept of this website is taken from a CodeWithHarry youtube video. socket.io has good documentation on their website which makes it really easy for a start.

---

To contribute to the project

Here are the steps you will need to follow to make your contributions.

If you don't have git on your machine, install it.

Fork this repository

Fork this repository by clicking on the fork button on the top of this page. This will create a copy of this repository in your account. Also you'll need to fork the codachat-server repo

Now clone the forked repository

Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the code button and then click the copy to clipboard icon.

Open a terminal and run the following git command:

$ git clone <url you just copied>

For example,

$ git clone https://github.com/mygithub-accnt/codachat.git

Create a branch

Change to the repository directory on your computer by,

$ cd codachat

#Create a branch using git checkout command
$ git checkout -b your-branch-name

Make necessary changes and commit those changes

After doing the required changes in the code, when you execute $ git status you'll see that there are some changes.

Add those changes to the branch you have just created using,

$ git add .

Now commit those changes with a meaningful message,

$ git commit -m "commit message"

Push changes into GitHub

$ git push origin your-branch-name

Submit your changes for review

If you go to your repository on GitHub, you'll see a Compare & pull request button. Click on that button.

Now submit the pull request.

Soon I'll review your code and merge your changes. So you will be considered as a contributor!