Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dun-sin/whisper
A fun Application to have a random chat with people safely
https://github.com/dun-sin/whisper
chat fun hacktoberfest javascript mongodb nextjs open-source reactjs socket-io tailwind tailwindcss
Last synced: 4 days ago
JSON representation
A fun Application to have a random chat with people safely
- Host: GitHub
- URL: https://github.com/dun-sin/whisper
- Owner: Dun-sin
- License: mit
- Created: 2022-04-17T11:48:44.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-12-12T09:50:06.000Z (about 1 month ago)
- Last Synced: 2025-01-13T08:41:08.899Z (8 days ago)
- Topics: chat, fun, hacktoberfest, javascript, mongodb, nextjs, open-source, reactjs, socket-io, tailwind, tailwindcss
- Language: JavaScript
- Homepage: https://whisper.favour.dev/
- Size: 2.76 MB
- Stars: 406
- Watchers: 7
- Forks: 391
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
## Whisper
This app is developed to make chatting much private and easy without stealing your data!!
### ✨ Built With
React
JavaScript
NodeJS
MongoDB
Docker
SocketIo
TailwindCSS
### 🖼️ Screenshot
## 📚 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:
- [Git](https://git-scm.com/downloads)
- [NodeJs](https://nodejs.org/en/download/)
- [Docker](https://docker.com/desktop)
### 🛠️ Installation
1. [Fork](https://github.com/Dun-sin/Whisper/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:
```bash
git clone https://github.com//Whisper
```
3. Navigate to the project directory
```bash
cd Whisper
```
4. Navigate to the respective client and server directory
```bash
cd client
```
```bash
cd server
```
5. Install dependencies with `npm install`
```bash
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
```bash
npm start
```
```bash
npm run dev:docker
```
> For those who do not wish to use Docker, here is another option -> [to start the project](https://github.com/Dun-sin/Whisper/blob/main/CONTRIBUTING.md#starting-the-project-without-docker)
8. 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](https://mailtrap.io/) using their demo to domain and get the token into .env
## 🎨 Demo
Check out the website: [Whisper](https://WhisChat.vercel.app/)
## 👩🏽💻 Contributing
- Contributions make the open source community such an amazing place to learn, inspire, and create.
- Any contributions you make are greatly appreciated.
- Check out our [contribution guidelines](/CONTRIBUTING.md) for more information.
## ✏️ Edit with Gitpod
Click this button to run this project in Gitpod which comes with pre-configured environment.
## 👨👩👦 Community
Don't forget to join the discord community - [Join us](https://discord.gg/ufcysW9q23)
## 🛡️ License
Whisper is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## 💪🏽 Thanks to all Contributors
Thanks a lot for spending your time helping Whisper grow. Thanks a lot! Keep rocking🍻
[](https://github.com/Dun-sin/Whisper/graphs/contributors)
## 🙏🏽 Support
This project needs a star️ from you. Don't forget to leave a star🌟
