Chatter

Login Details for Testing

email: test@gmail.com
password: test1234

email: test2@gmail.com
password: test1234

UI Look

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Contributing
4. Contact

About The Project

• This project is a Real-time Chat web-app.
• One can chat in group conversations and if they want to chat in private, then that is also available.

Built With ~~

This project is built with the latest MERN stack technology, Socket.io for Real-time chat handling, React for frontend, React-Redux for state managment, Express/Node for API, server and MongoDB for database, including json-webtoken for authorization.

• React
• React-Redux
• Socket
• MongoDB
• Express
• json-webtoken

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

The only thing required to download other dependencies is npm.

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/lavlife06/Chatter.git

2. Install NPM packages

   npm install

   in client folder - npm install

• These will download every dependencies for frontend and backend

4. Set up MongoDB database

• Make a project in MongoDB
• You will get your cluster's mongoURI to use database of your project
• Enter your mongoURI in config.js

const mongoURI = 'ENTER YOUR MongoDB URI here';

5. Run

  npm run dev

Contributing

I believe 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. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contact

Name - Lav Senghani - lavsenghani@gmail.com