Scrollme is a modern, real-time chat application designed to deliver a fast and intuitive messaging experience. With support for one-on-one and group chats, Scrollme provides seamless communication through a clean, user-friendly interface.
- Real-Time Messaging: Instant updates powered by WebSockets for a seamless experience.
- Group Chat: Communicate with multiple users in a single conversation.
- Responsive Design: Fully optimized for desktop and mobile views.
- User Authentication: Secure sign-up and login functionality.
- Customizable Themes: Switch between light and dark mode to suit your preference.
- Optimized Performance: Lightweight and efficient, suitable for high-traffic use.
- Frontend: React, Tailwind CSS
- Backend: Node.js, Express
- Database: MongoDB
- WebSocket: Socket.IO
- Authentication: JWT (JSON Web Tokens)
- Features
- Tech Stack
- Installation
- Usage
- Contributing
- Code of Conduct
- Project Structure
- License
- Contact
-
Clone the repository:
git clone git@github.com:saurabhbakolia/Scrollme-Chat-Application.git cd scrollme
-
Install dependencies for both client and server:
npm install # Install backend dependencies cd client && npm install # Install frontend dependencies
-
Configure environment variables::
-
Create a .env file in the root directory and add your environment variables (e.g., MongoDB URI, JWT secret, etc.).
-
Sample:
MONGO_URI=your_mongodb_uri JWT_SECRET=your_jwt_secret
- Start the application:
- To start both the frontend and backend servers, run:
npm run dev
After installation, open your browser and go to http://localhost:3000 to access the Scrollme chat application.
Register a new account or log in with an existing account. Create or join a chat room to start messaging. Invite others to join the conversation for group chat experience.
Contributions are what make the open-source community a great place to learn, inspire, and create. Any contributions you make to Scrollme are greatly appreciated.
- Fork the Project.
- Create your Feature Branch: git checkout -b feature/AmazingFeature.
- Commit your Changes: git commit -m 'Add some AmazingFeature'.
- Push to the Branch: git push origin feature/AmazingFeature.
- Open a Pull Request.
Please refer to the CONTRIBUTING.md for more details.
We expect all contributors to uphold our Code of Conduct. Please be respectful in interactions with fellow contributors.
Scrollme/ ├── client/ # Frontend application (React) ├── server/ # Backend server (Node.js, Express) ├── .env.example # Environment variables example ├── LICENSE # License file ├── README.md # Project documentation └── CONTRIBUTING.md # Contribution guidelines
This project is licensed under the MIT License - see the LICENSE file for details.