update logo, fix reply to thread...

Author: wiseaidev

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+`support` room in the platform.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -0,0 +1,59 @@
+# 🌍 Contributing.
+
+Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
+
+## 👶 Getting Started!
+
+Ready to contribute? Here's how to set up `code-inbox` for local development.
+
+1. Fork the `code-inbox` repo on GitHub.
+2. Clone your fork locally:
+
+```sh
+git clone git@github.com:your_name_here/code-inbox.git
+```
+
+3. Navigate to the recently created directory:
+
+```sh
+cd code-inbox
+```
+
+4. Install the main dependencies:
+
+```sh
+pnpm install
+```
+
+5. Create a branch for local development:
+
+```sh
+git checkout -b name-of-your-bugfix-or-feature
+```
+
+6. Set the following env variables:
+
+```sh
+export VITE_SERVER_URL=http://localhost:8000/api/v1
+```
+
+Now you can make your changes locally.
+
+7. Commit your changes and push your branch to GitHub:
+
+```sh
+git add .
+git commit -m "Your detailed description of your changes."
+git push origin name-of-your-bugfix-or-feature
+```
+
+8. Submit a pull request through the GitHub website.
+
+
+## 📙 Pull Request Guidelines.
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include tests, if applicable.
+
+Thank you for helping us improve!

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Mahmoud
+Copyright (c) 2023 Mahmoud Harmouch
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,8 +1,183 @@
-# React + Vite
+# Brave Chat
 
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+[![Demo on Cloudflare](https://badgen.net/badge/icon/cloudflare/green?icon=telegram&label=brave-chat)](https://brave-chat.net/)
+[![Tag](https://badgen.net/github/tag/brave-chat/brave-chat)](https://github.com/brave-chat/brave-chat/releases/tag/v0.4.0)
+[![Docs](https://badgen.net/badge/icon/docs?icon=wiki&label)](https://docs.brave-chat.wiseai.dev)
+[![All Contributors](https://img.shields.io/badge/all_contributors-3-blue.svg?style=flat)](#contributors-)
 
-Currently, two official plugins are available:
+![Brave Chat](./docs/static/images/banner.PNG "Brave Chat")
 
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+Brave Chat is a fully featured chat application developed to bring the power back to people. It's designed to be the ultimate open source slack alternative with privacy in mind. It is user-friendly with a clean interface that is easy to navigate.
+
+As well as being feature-rich, Brave Chat is also fully responsive, meaning it will work seamlessly on a wide range of devices. So whether you're chatting on your desktop or your mobile, you'll always have a great experience.
+
+## Supported Features
+
+- Forms validations.
+
+![Email validation.](./docs/static/images/input-validation.png)
+
+![Email validation.](./docs/static/images/password-validation.png)
+
+- Keyboard shortcuts.
+
+![Keyboard shortcuts.](./docs/static/images/keyboard-shortcuts.png)
+
+- Sending and receiving text messages in real time.
+
+![Sending and receiving text messages.](./docs/static/images/snd-rcv-text.gif)
+
+- Sending and receiving images in real time.
+
+![Sending and receiving images.](./docs/static/images/snd-rcv-img.gif)
+
+- Instant notifications when submitting a form.
+
+![Joining a room notification.](./docs/static/images/join-room-notification.png)
+
+![add contact notification.](./docs/static/images/add-contact-notification.png)
+
+- Adding and removing a contact using an email address of a registered user.
+
+![Add contact form.](./docs/static/images/add-contact-form.png)
+
+- Display chat list with unread messages count as a badge and timestamps.
+
+![Custom badges, unread messages count, and timestamps.](./docs/static/images/custom-badges.png)
+
+- Joining and creating rooms given a room name and or description.
+
+![Create room form.](./docs/static/images/create-room.png)
+
+- The ability to click on an avatar in a room to reveal detailed information about a given user.
+
+![Room User Details.](./docs/static/images/room-user-details.png)
+
+- Emojies support.
+
+![Emojies support.](./docs/static/images/emojies.png)
+
+- The ability to leave a room, and delete sent messages.
+
+![Delete messages.](./docs/static/images/delete-messages.png)
+
+![Deleted messages.](./docs/static/images/deleted-messages.png)
+
+- The ability to render HTML tags, links, emails.
+
+![HTML tags being rendered.](./docs/static/images/bold-italic.png)
+
+- The ability to render Markdown text.
+
+![HTML tags being rendered.](./docs/static/images/render-markdown.png)
+
+- The ability to ban and unban room members.
+
+![HTML tags being rendered.](./docs/static/images/moderation.gif)
+
+## 2023 Roadmap
+
+- Enrypt and decrypt text messages on the client side using the signal protocol.
+- Add support for voice, videos, files messages.
+- Add support for voice and video calls.
+
+## Components
+
+Brave Chat code base is written to be developer-friendly, with code that is both standards-compliant and optimised for performance. It contains a handful list of reusable components. You can take a look at various components in [this section](https://chat-docs.wiseai.dev/folder-structure) of the docs, or expand the following collapsed section.
+
+### Running locally with NPM
+
+> **Note**<br>
+Make sure you have [`pnpm`](https://pnpm.io/installation) installed on your machine.
+
+1. Fork/Clone the repo:
+
+	```sh
+	git clone git@github.com:brave-chat/brave-chat.git
+	```
+
+1. Open the newly created directory:
+
+	```sh
+	cd brave-chat
+	pnpm install
+	```
+
+> **Warning**<br>
+In order to run the project locally or build for production use, you will need to set the following environment variables to connect with the server.
+
+```sh
+REACT_APP_SERVER_URL=http://localhost:8000/api/v1
+REACT_APP_SOCKET_URL=ws://localhost:8000/api/v1/ws
+```
+
+1. Now, you can run the client:
+
+	```sh
+	pnpm run dev
+	```
+
+1. Navigate to [http://localhost:3000](http://localhost:3000) to explore the landing page.
+
+## Running locally with Compose v2
+
+Navigate to [the server repository](https://github.com/brave-chat/brave-chat-server) and follow the instructions listed in [this section](https://github.com/brave-chat/brave-chat-server#running-locally-with-compose-v2) to run both the client and the server in docker containers.
+
+## Deployment
+
+> **Warning**<br>
+To deploy the client, you will need to set the following environment variables that help the client connect to the server.
+
+```sh
+* REACT_APP_SERVER_URL - Your deployed server APIs url.
+* REACT_APP_SOCKET_URL - Your deployed server Sockets url.
+```
+
+### **Deploy to a Static Hosting Provider**
+
+### **CloudFlare**
+
+1. Install [Wrangler CLI](https://developers.cloudflare.com/workers/wrangler/get-started/):
+
+   To get started with Cloudflare Workers, you'll need to install the Wrangler CLI, which is a powerful tool for managing your deployments. Open up your command-line interface and enter the following command to globally install Wrangler:
+
+   ```sh
+   npm install -g wrangler
+   ```
+
+1. Login to Cloudflare Account from the CLI:
+
+   To seamlessly interact with your Cloudflare account, you'll need to log in using Wrangler. Run the following command in your terminal:
+
+   ```sh
+   wrangler login
+   ```
+
+1. Configure Environment Variables for Client-Server Connection:
+
+   For your React app to communicate effectively with the server, you need to set a couple of environment variables. Replace the placeholders with actual URLs:
+
+   ```sh
+   export REACT_APP_SERVER_URL=Your_deployed_server_APIs_url
+   export REACT_APP_SOCKET_URL=Your_deployed_server_Sockets_url
+   ```
+
+1. Run Your Build Command:
+
+   Before deployment, ensure your project is finely tuned. Execute your build command to prepare your app for the world:
+
+   ```sh
+   pnpm run build
+   ```
+
+1. Create a New Deployment:
+
+   The moment has come to launch your creation into the online realm! Execute the following command to deploy your app with Wrangler Pages:
+
+   ```sh
+   wrangler pages deploy dist
+   ```
+
+### **Netlify**
+
+[![Deploy on Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/brave-chat/brave-chat)