Skip to content

Latest commit

 

History

History
65 lines (51 loc) · 1.71 KB

README.md

File metadata and controls

65 lines (51 loc) · 1.71 KB

Chat Application

This is a real-time chat application built using React, Firebase, and Redux. It allows users to sign up, log in, send and receive messages, and manage their chats.

Table of Contents

  1. Features
  2. Tech Stack
  3. Libraries Used
  4. Getting Started
  5. Folder Structure
  6. Recent Updates

Features

  • User Authentication (Sign Up, Log In)
  • Real-time Messaging
  • Emoji Picker Integration
  • File and Media Uploads
  • Audio Message Recording and Playback
  • User Profile Management
  • Chat Search
  • Contact List Management
  • Online Status and Last Seen

Tech Stack

  • Frontend: React, Redux, Material Tailwind
  • Backend: Firebase (Authentication, Firestore, Storage)
  • Deployment: Vite

Libraries Used

  • react: For building the user interface
  • redux: For state management
  • react-redux: To connect React components with Redux
  • firebase: For backend services
  • material-tailwind: For UI components
  • react-icons: For iconography
  • emoji-picker-react: For emoji selection
  • wavesurfer.js: For audio waveform visualization

Getting Started

  1. Clone the repository: 
    git clone https://github.com/eric-muganga/SignalShift.git
cd SignalShit
  2. Install dependencies: 
    npm install
  3. Create a .env file in the root directory and add your Firebase configuration: 
    VITE_API_KEY=your-api-key
VITE_AUTH_DOMAIN=your-auth-domain
VITE_PROJECT_ID=your-project-id
VITE_STORAGE_BUCKET=your-storage-bucket
VITE_MESSAGING_SENDER_ID=your-messaging-sender-id
VITE_APP_ID=your-app-id
  4. Run the application: 
    npm run dev