Peer-to-Peer Chat App 🌐💬

Welcome to the Peer-to-Peer Chat App repository! This project is a simple chat application built using Tauri, leveraging Iroh Gossip for peer-to-peer communication without the need for servers. Below, you will find detailed information about the project, its features, setup instructions, and more.

Table of Contents

1. Features
2. Technologies Used
3. Installation
4. Usage
5. Contributing
6. License
7. Releases
8. Contact

Features

• Peer-to-Peer Communication: Direct chat between users without a central server.
• Cross-Platform: Works on multiple operating systems including Windows, macOS, and Linux.
• Lightweight: Minimal resource usage due to the absence of server infrastructure.
• Real-Time Messaging: Instant message delivery with Iroh Gossip.
• User-Friendly Interface: Built with React and styled using Tailwind CSS for a clean look.
• Mobile Compatibility: Designed to work seamlessly on Android devices.

Technologies Used

This project utilizes a variety of technologies to create a robust chat application:

• React: For building user interfaces.
• Rust: Backend logic and performance optimization.
• Tauri: To create a lightweight desktop application.
• Iroh Gossip: For decentralized messaging.
• Tailwind CSS: For responsive and modern design.
• TypeScript: For type safety and improved developer experience.
• ViteJS: For fast development and build processes.

Installation

To get started with the Peer-to-Peer Chat App, follow these steps:

1. Clone the Repository:

   git clone https://github.com/PhanordCode/peer-to-peer.git
   cd peer-to-peer

2. Install Dependencies: Make sure you have Node.js and Rust installed. Then run:

   npm install

3. Build the Application: Use Vite to build the application:

   npm run build

4. Run the Application: You can run the application using Tauri:

   npm run tauri dev

Usage

Once the application is running, you can start chatting with other users. Follow these steps:

1. Create a User Profile: Enter a username when prompted.
2. Connect with Peers: Share your connection link with friends.
3. Start Chatting: Send and receive messages in real-time.

The application supports multiple users and allows for group chats as well.

Contributing

We welcome contributions to enhance the Peer-to-Peer Chat App. If you want to contribute, please follow these steps:

1. Fork the Repository: Click on the fork button in the top right corner.
2. Create a New Branch:

   git checkout -b feature/YourFeatureName

3. Make Your Changes: Implement your feature or fix.
4. Commit Your Changes:

   git commit -m "Add your message here"

5. Push to Your Branch:

   git push origin feature/YourFeatureName

6. Open a Pull Request: Go to the original repository and create a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Releases

To download the latest version of the Peer-to-Peer Chat App, visit our Releases section. Here, you can find the latest builds for various platforms. If you need a specific file, download it and execute it as per your system requirements.

Contact

For any questions or feedback, feel free to reach out:

• Email: [email protected]
• Twitter: @YourTwitterHandle

Thank you for checking out the Peer-to-Peer Chat App! We hope you enjoy using it and contributing to its development.