README.md

Table of Contents

• Convoz
  • 🚀 Visit Live Website
  • 🔥 Features
  • 🛠️ Stack
  • 📙 Getting Started
  • 🗂️ Project Structure
  • 🤝 Contributing
  • 🎖️ Contributors
  • 📜 License

Convoz

Open-source chat platform with discord-like features built with React, Redux, Vite and Firebase

🚀 Visit Live Website

🔥 Features

• Real-time Chat: Responsive chat experience with real-time updates
• Channel Management: Create, join and manage channels easily
• User Authentication: Secure user authentication with Google Sign-In
• User-Friendly Interface: Intuitive UI/UX design to enhance user experience

🛠️ Stack

This project was built using the following technologies:

• ⚛️ React
• 🔷 TypeScript
• 🔥 Firebase
• 🧰 Redux Toolkit
• ⚡ Vite
• 🔍 ESLint
• 🪝 react-firebase-hooks
• 🚦 react-router-dom
• 🎨 Tailwind CSS

📙 Getting Started

To get started with this project, follow these steps:

1. Clone the repository to your local machine.
2. Install the dependencies by running npm install.
3. Start the development server by running npm start.

🗂️ 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

🤝 Contributing

This project is perfect for learners and open-source enthusiasts. We welcome contributions from everyone!

You can contribute in many ways:

• ⭐ Star the repo
• 🐞 Report bugs
• 💡 Suggest new features
• 👩‍💻 Implement new features/bug fixes

Please check out our Contribution Guide for more details.

🎖️ Contributors

Hein Thant 💻 🎨

Pratyush Joshi 💻

tran1109 💻

📜 License

This project is licensed under the MIT License - see the LICENSE for details.