Skip to content

Latest commit

 

History

History
81 lines (68 loc) · 2.2 KB

README.md

File metadata and controls

81 lines (68 loc) · 2.2 KB

Chibi-chat

image

A lightweight and fast real-time chat application built with Socket.io, TypeScript, Vite, and Tailwind CSS. This application allows anyone to create and join chat rooms to communicate anonymously or with a chosen name.

Features

  • 🌐 Real-Time Chat: Seamless and instant messaging powered by Socket.io.
  • 🏠 Room Creation: Create unique chat rooms or join existing ones.
  • 👤 Anonymous or Named Chat: Chat anonymously or set a display name.
  • ⚡ Fast and Responsive: Built with Vite for a smooth development experience and optimized performance.
  • 🎨 Customizable UI: Styled with Tailwind CSS for modern and responsive design.

Technologies Used

Socket.io: For real-time, bidirectional communication. TypeScript: For type safety and better development experience. Vite: For fast builds and hot module replacement during development. Tailwind CSS: For responsive and customizable UI design. Getting Started Follow these steps to run the application locally.

Prerequisites

Node.js (v14+) npm or yarn Installation Clone the repository:

Copy code
git clone https://github.com/your-username/chat-app.git
cd chat-app

Install dependencies:

Copy code
npm install
# or
yarn

Start the development server:


npm run dev
# or
yarn dev

Open your browser and navigate to: http://localhost:5173 Build for Production To create an optimized production build:

npm run build
# or
yarn build

Usage Open the app in your browser. Create a new chat room or join an existing one by entering the room name. Start chatting anonymously or enter a name to personalize your messages. Screenshots (Add relevant screenshots here showing the UI and functionality)

Contributing Contributions are welcome! If you find a bug or have a feature request, feel free to open an issue or submit a pull request.

  • Fork the repository.
  • Create a new branch for your feature:
git checkout -b feature-name

Commit your changes and push them:

git add .
git commit -m "Add feature"
git push origin feature-name

Open a pull request.