Deploy updates

.env.example

@@ -0,0 +1,12 @@
+# Change this file to .env.local and fill in the values.
+
+# Firebase configuration
+VITE_API_KEY=
+VITE_AUTH_DOMAIN=
+VITE_PROJECT_ID=
+VITE_STORAGE_BUCKET=
+VITE_MESSAGING_SENDER_ID=
+VITE_APP_ID=
+
+# General channel ID
+VITE_GENERAL_CHANNEL_ID=

.github/workflows/linters.yml

@@ -0,0 +1,22 @@
+name: Linters
+
+on:
+  push:
+    branches: ["main", "dev"]
+  pull_request:
+    branches: ["main", "dev"]
+
+jobs:
+  ESLint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Setup Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: '16.x'
+      - name: Install dependencies
+        run: npm ci
+      - name: Run ESLint
+        run: npm run lint

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
+[email protected].
+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,40 @@
+# Contributing to Convoz
+
+Thank you for your interest in contributing to Convoz! We welcome contributions from anyone, whether you're an experienced developer or just getting started.
+
+## Ways to Contribute
+
+You can contribute to Convoz in many ways:
+
+1. **Code Contributions:** You can help improve our project by submitting code changes or bug fixes. If you're new to open source, you can start by looking at issues labeled as [good first issue](https://github.com/IndieCoderMM/convoz-chat/labels/good%20first%20issue).
+
+2. **Bug Reports:** If you encounter a bug or unexpected behavior, [open an issue](https://github.com/IndieCoderMM/convoz-chat/issues/new) in our repository and provide details about the problem.
+
+3. **Feature Requests:** If you have an idea for a new feature, please [create an issue](https://github.com/IndieCoderMM/convoz-chat/issues/new) to discuss it. We're open to new ideas and enhancements.
+
+4. **Feedback:** Your feedback is invaluable. If you have suggestions or thoughts about the project, please share them in our discussions or issue tracker.
+
+## Getting Started
+
+1. Fork the repository to your own GitHub account.
+2. Clone the repository to your local machine.
+3. Install the dependencies by running `npm install`.
+4. Create a new branch for your changes by running `git checkout -b my-new-branch`.
+5. Change `.env.example` to `.env` and fill in the required values.
+6. Start the development server by running `npm start`.
+7. Push your changes to your fork.
+8. Submit a pull request to the original repository.
+
+## Code Style
+
+We use ESLint to enforce a consistent code style throughout the project. Before submitting a pull request, please make sure that your code passes the ESLint checks by running `npm run lint`.
+
+## Code of Conduct
+
+We expect all contributors to follow our [Code of Conduct](./CODE_OF_CONDUCT.md). Be respectful and inclusive in all interactions.
+
+## License
+
+By contributing to [Your Project Name], you agree that your contributions will be licensed under the project's [LICENSE](./LICENSE) unless specified otherwise.
+
+Thank you for contributing to our project. Your help is greatly appreciated!

LEARN.md

@@ -0,0 +1,70 @@
+# Convoz
+
+Convoz is a real-time chat platform designed to offer a responsive chat experience with features similar to Discord.
+
+## Built with
+
+Convoz is powered by a modern technology stack:
+
+- React: A JavaScript library for dynamic user interfaces.
+- Redux Toolkit: Manages application state effectively.
+- Firebase: Handles user authentication and real-time data synchronization.
+- Vite: Optimizes performance and builds the project efficiently.
+- react-firebase-hooks: Simplifies Firebase integration with React.
+- react-router-dom: Handles routing within the application.
+- Tailwind CSS: Provides responsive and visually appealing styling.
+- TypeScript: Adds type safety and code validation to the project.
+- ESLint: Enforces code quality and standards.
+
+## Project Structure
+
+The project is structured as follows:
+
+```
+.
+├── src/
+│   ├── assets
+│   ├── components
+│   ├── features/
+│   │   ├── Channels/
+│   │   │   ├── CreateChannel.tsx
+│   │   │   └── channelsSlice.ts
+│   │   └── Chat
+│   ├── lib/
+│   │   ├── firebase.ts
+│   │   └── store.ts
+│   ├── pages/
+│   │   ├── Landing.tsx
+│   │   └── Channels.tsx
+│   ├── styles
+│   ├── App.tsx
+│   ├── main.tsx
+│   └── RootLayout.ts
+├── package.json
+└── tailwind.config.js
+```
+
+- `src/assets`: Store all project assets, such as images and icons
+- `src/components`: For reusable React components across different pages
+- `src/features/`: Contains the main features of our application:
+  - `Channels/`: Things related to channels, for example:
+    - `CreateChannel.tsx`: Handles the creation of channels
+    - `channelsSlice.ts`: Defines the Redux slice for channels
+  - `Chat/`: Things related to chat ...
+- `src/lib/`: For utility files
+  - `firebase.ts`: Handles Firebase configuration and initialization
+  - `store.ts`: Configures the Redux store 
+- `src/pages/`: Store individual page components
+- `src/styles`: Contains global styles and Tailwind CSS configuration
+- `src/App.tsx`: Defines all routes and handles authentication
+- `src/RootLayout.tsx`: Defines the app layout
+- `src/main.tsx`: Configures and starts the application.
+
+
+
+## Contributing
+
+If you'd like to contribute to the project, here's how to get started:
+
+- [Contribution Guidelines](CONTRIBUTING.md): Review our guidelines for code, documentation, and more.
+- [Code of Conduct](CODE_OF_CONDUCT.md): Ensure you follow our code of conduct during your interactions.

README.md

@@ -1,6 +1,10 @@
-# Convoz - Chat Platform 
+# Convoz
 
-Convoz is an open-source chat platform with discord-like features, designed to bring people together in a real-time, engaging online communities. 
+> Open-source chat platform with discord-like features built with React, TypeScript, Vite and Firebase
+
+**Visit the [Live Website](https://convoz-chat.onrender.com/)**
+
+![Convoz Screenshot](./screenshot.png)
 
 ## Features
 
@@ -18,10 +22,10 @@ This project was built using the following technologies:
 - Firebase
 - Redux Toolkit
 - Vite
+- ESLint
 - react-firebase-hooks
 - react-router-dom
-- ESLint
-- react-hot-toast
+- Tailwind CSS
 
 ## Getting Started