Skip to content
Eli Van Stichelen edited this page Jan 24, 2024 · 1 revision

ChatSolid - React Solid Chat App Wiki

Welcome to the React Solid Chat App Wiki! This comprehensive guide provides insights into the project's architecture, usage, and contribution guidelines.

Introduction

The React Solid Chat App is an innovative project integrating Solid principles for decentralized data management with React's robust frontend capabilities. This application demonstrates the use of Solid POD storage and Solid Project authentication, showcasing a future where web development is more user-centric. Our open-source initiative aims to promote and facilitate the adoption of Solid methodologies in web applications.

Getting Started

To get started with the React Solid Chat App:

Clone the Repository: Clone the project from GitHub to your local machine. Install Dependencies: Run npm install to install all required dependencies. Run Development Server: Launch a local server using npm start. Set Up Solid POD: Create or use an existing Solid POD for testing and authentication. Project Structure The application is structured to facilitate easy navigation and development. It uses WebRTC for peer-to-peer communication in chats and integrates with Solid for user authentication and data storage. The core components include user authentication, chat interface, and WebRTC handling.

How to Contribute

Contributors are welcome to enhance the app's features or fix bugs. Please follow these guidelines:

Submit issues and pull requests through GitHub. Adhere to established coding standards and best practices. Suggest new features or improvements via GitHub issues. Using the Chat App Utilize the chat application by:

Logging In: Use Solid credentials for authentication. Starting a Chat Session: Engage in peer-to-peer chat with other users. Exploring Features: Discover various chat functionalities within the app. Troubleshooting Encounter an issue? Check out the common problems and their solutions in this section. For additional help, raise an issue on GitHub or contact me at eli.vanstichelen@student.odisee.be.

Community and Support

Join the Solid Community Forum for discussions and sharing experiences. For private feedback or support, reach out through the Inrupt Service Desk.

License

The React Solid Chat App is licensed under the GNU General Public License v3.0. This license allows for modification and distribution under the same terms.