Dun-sin / Whisper

A fun Application to have a random chat with people safely
https://whisper.favour.dev/
MIT License
402 stars 375 forks source link
chat fun hacktoberfest javascript mongodb nextjs open-source reactjs socket-io tailwind tailwindcss

Whisper

An app to help you chat in secret

View Demo Β· Report Bug Β· Request Feature

GitHub Repo stars contributors GitHub Repo forks issues

Whisper

This app is developed to make chatting much private and easy without stealing your data!!

✨ Built With

React
React
Javascript
JavaScript
NodeJS
NodeJS
MongoDB
MongoDB
MongoDB
Docker
SocketIo
SocketIo
TailwindCSS
TailwindCSS

πŸ–ΌοΈ Screenshot

image

(back to top)

πŸ“š Getting Started

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

πŸ‘‡πŸ½ Prerequisites

Before installation, please make sure you have already installed the following tools:

πŸ› οΈ Installation

  1. Fork the project. Click on the fork icon in the top right to get started

  2. Clone the project, you can use the following command:

    git clone https://github.com/<your-github-username>/Whisper
  3. Navigate to the project directory

    cd Whisper
  4. Navigate to the respective client and server directory

    cd client
    cd server
  5. Install dependencies with npm install

    npm install
  6. Use .env_sample to configure the .env file for both client and server. For the server .env mongodb url use the localhost to test

    Check this video of how to do that: https://www.youtube.com/watch?v=D0U8vD8m1I0
    Note: If using Docker, the MongoDB port is 27018

  7. Run npm start in the client directory and npm run dev:docker in the server directory, this uses docker for the server part

    npm start
    npm run dev:docker

For those who do not wish to use Docker, here is another option -> to start the project

  1. To test things out, you can open the same URL in two different browsers or open a private browsing window in the same browser. This allows you to connect to yourself, use login anonymously if you aren't dealing with anything that uses user data, else use login and open an account on mailtrap using their demo to domain and get the token into .env

(back to top)

🎨 Demo

Check out the website: Whisper

(back to top)

πŸ‘©πŸ½β€πŸ’» Contributing

(back to top)

✏️ Edit with Gitpod

Click this button to run this project in Gitpod which comes with pre-configured environment.

<img src="https://img.shields.io/badge/Contribute%20with-Gitpod-908a85?logo=gitpod" alt="Contribute with Gitpod" />

(back to top)

πŸ‘¨β€πŸ‘©β€πŸ‘¦ Community

Don't forget to join the discord community - Join us

πŸ›‘οΈ License

Whisper is licensed under the MIT License - see the LICENSE file for details.

(back to top)

πŸ’ͺ🏽 Thanks to all Contributors

Thanks a lot for spending your time helping Whisper grow. Thanks a lot! Keep rocking🍻

Contributors

(back to top)

πŸ™πŸ½ Support

This project needs a star️ from you. Don't forget to leave a star🌟

(back to top)