Skip to content

neeraj-395/chatkit

Repository files navigation

ChatKit (TypeScript)

A simple real-time chat application built using React, TypeScript. This is a TypeScript-based rebuild of the original JavaScript project by Dulanjali Senarathna, enhanced for better type safety, maintainability, and scalability.

📦 Installation

  1. Clone the repository

    git clone https://github.com/neeraj-395/chatkit.git
    cd chatkit
  2. Install dependencies

    npm i or npm i --force # if any error
  3. Run the application

    npm run dev

📁 Project Structure

src/
├── app/                  # Global config, hooks, and Redux store
├── assets/               # Static assets and mock data
├── components/           # Reusable UI components
│   ├── chat/             # Chat-related UI (input, item, badge, tooltip)
│   ├── conversation/     # Header, footer, timeline of chat
│   ├── form/             # Auth and form elements
│   ├── layouts/          # Page layout wrappers
│   ├── message/          # Different message types (text, media, reply, etc.)
│   ├── navbar/           # Navigation bar and menu items
│   ├── search/           # Search bar and logic
│   ├── settings/         # User settings UI
│   └── sidebar/          # Sidebar components (contacts, starred, etc.)
├── features/             # Redux feature slices
├── hooks/                # Custom React hooks
├── routes/               # App routes (SignIn, SignUp, Chats, etc.)
├── theme/                # MUI theme customization and overrides
├── App.tsx               # Root component
├── main.tsx              # App entry point
├── index.css             # Global styles
└── vite-env.d.ts         # Vite environment typings

🙏 Credits

This TypeScript-based version is a rebuild of the original React Chat App by:

Special thanks for the inspiration and original implementation.

About

Starter template for building real-time chat apps with React and TypeScript.

Resources

License

Stars

Watchers

Forks

Languages