Hide - Out : ChatApp

Hide-Out is a real-time web chat application that allows users to communicate with each other.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

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

About The Project

Hide-Out is a real time chat application with amazing additionals features such as one click google login, image and profile picture upload, and emoji support.

Built With

• React.js
• Node.js
• MongoDB
• Socket.io

(back to top)

Getting Started

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

Prerequisites

• npm

  npm install npm@latest -g

• initialize npm

  npm init -y

• install dependancies

  npm install

• create frontend folder

  npx create-react-app

• install frontend dependancies

  cd frontend
  npm install

Installation

1. Create free account at at cloudinary.com, console.cloud.google.com, mongodb.com
2. Create .env file in root folder as below :-

 MONGODB_URI = 'ENTER YOUR MONGODB URI'
 PORT = '5000'
 NODE_ENV = 'development / production'
 JWT_SECRET = 'CREATE A JWT SECRET KEY'
 GOOGLE_CLIENT_ID = 'ENTER YOUR GOOGLE CLIENT ID' 

3. Create .env file in client folder as below :-

 REACT_APP_GOOGLE_CLIENT_ID = 'ENTER YOUR GOOGLE CLIENT ID'
 REACT_APP_CLOUDINARY_CLOUD_NAME = 'ENTER YOUR CLOUDINARY CLOUD NAME'
 REACT_APP_CLOUDINARY_UPLOAD_PRESET = 'ENTER YOUR CLOUDINARY UPLOAD PRESET'

(back to top)

Roadmap

• Create Error Handling Snackbar
• Enable Forgot Password option for users
• A user profile page for editing user details
• Add additional features to rigthBar

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Ritwik Singh - sritwik2@gmail.com

Project Link: https://github.com/LitoleNINJA/Chat-App

(back to top)