Skip to content

Latest commit

 

History

History
84 lines (59 loc) · 1.88 KB

README.md

File metadata and controls

84 lines (59 loc) · 1.88 KB

Linkle Chat

Linkle is a real-time chat application that connects users through WebSockets. It allows users to send and receive messages instantly while providing a seamless user experience.

Features

  • Real-time Messaging: Communicate instantly with other users.
  • User Connection Management: Connect and disconnect from other users.
  • Message Notifications: Receive notifications for connection status and new messages.
  • Chat Clearing: Clear chat messages when a new user connects.
  • Dark-themed UI: A modern dark theme for an enhanced user experience.

Technologies Used

Frontend

  • React: For building the user interface.
  • TypeScript: For type safety and improved development experience.
  • Socket.IO Client: For real-time communication with the server.
  • Tailwind CSS: For styling the application with utility-first CSS.

Backend

  • Node.js: JavaScript runtime for building the server.
  • Express.js: Web framework for building APIs.
  • Socket.IO: For real-time bi-directional communication between clients and server.

Deployment

  • Frontend: Deployed on Vercel.
  • Backend: Deployed on Render.

Installation

To set up the project locally, follow these steps:

Prerequisites

  • Node.js (version 14 or later)
  • npm or Yarn

Clone the Repository

git clone https://github.com/your-username/linkle.git
cd linkle

Frontend Setup

  • Navigate to the frontend directory:
cd frontend
  • Install dependencies:
npm install
  • Start the development server:
npm start

Backend Setup

  • Navigate to the backend directory:
cd backend
  • Install dependencies:
npm install
  • Start the server:
node server.js

Contributing:

Contributions are welcome! Please feel free to open issues or submit pull requests.