Skip to content

Latest commit

ย 

History

History
73 lines (46 loc) ยท 1.72 KB

File metadata and controls

73 lines (46 loc) ยท 1.72 KB

Real Time Chat App

This is a simple real-time chat application that allows you to chat with others in real time. ๐Ÿ’ฌ

๐Ÿš€ Features

  • User authentication with JWT ๐Ÿ”’
  • Real-time messaging with Socket.io ๐Ÿ’ฌ
  • State management with Zustand ๐Ÿ“‹
  • Styled with Tailwind CSS ๐Ÿ’…
  • MongoDB for data storage ๐Ÿ’พ

๐Ÿ“– Installation

  1. Clone the repository:

    git clone https://github.com/ucfx/react-chat.git
  2. Navigate to the project directory:

    cd react-chat
    
  3. Install the dependencies for both client and server folders:

     cd client && npm i && cd ../server && npm i && cd ..
    
  4. Create a .env file in the server directory and add your environment variables. You can use the .env.example file as a template:

    cp server/.env.example server/.env
    

    Modify the .env file with your environment-specific variables.

  5. Start the client:

    cd client && npm run dev
    
  6. Open another terminal, navigate to the project directory, and start the server:

    cd server && npm run dev
    
  7. Open your browser and visit http://localhost:5173.

  8. Start chatting in real-time! ๐Ÿ˜‰

๐Ÿ”— Demo

๐Ÿ–ผ๏ธ Screenshots

Login Login Login

๐Ÿค Contributing

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

๐Ÿ“ƒ License

This project is licensed under the MIT License.