Skip to content

Latest commit

 

History

History
68 lines (45 loc) · 1.7 KB

README.md

File metadata and controls

68 lines (45 loc) · 1.7 KB

Roundtable Chat 🌐

Warning This project is still in development and is not ready for production use.

Welcome to Roundtable Chat, a Discord like chat website / web app built using React.js, MongoDB, Express.js, Node.js, Vite, Tailwind CSS, and Daisy UI. It provides users with a platform to engage in conversations, create chat rooms, and connect with others in a seamless and interactive way.

🚀 Features

  • Real-time chat functionality(working on it 😢)
  • User authentication with JWT and registration 🔒
  • Group chat and personal chat👥
  • Multiple Chatrooms for a single group chat 🏰
  • Member Roles for Group chats 💬
  • More features coming soon.....💻

📚 Installation

  1. Clone the repository:
git clone https://github.com/shivamchhapola/roundtable-chat.git
  1. Navigate to the project directory:
cd roundtable-chat
  1. Install the dependencies using npm or yarn:
npm install
  1. Configure the environment variables: Rename the .env.example file to .env. Update the necessary environment variables like MongoDB connection string and JWT secret.

  2. Start the development server:

npm run dev
  1. Open your browser and visit http://localhost: (whatever port, see your terminal) to see the Roundtable Chat application.

🛠️ Technologies Used

  • Vite + React.js ⚛️
  • MongoDB 🗃️
  • Express.js 🖥️
  • Node.js 🌐
  • Tailwind CSS 🎨
  • Daisy UI 🎨

💡 Contributing

Contributions are welcome! If you have any suggestions, improvements, or bug fixes, please open an issue or submit a pull request.

📝 License

This project is licensed under the MIT License.

⬛ Screenshots

(will be adding them later)