README.md

We Chat

Welcome to We Chat! This chat application provides support for private messages, group chats, and user authentication. Built with GraphQL subscriptions, React, TypeScript, Redis, PostgreSQL, Nest.js, Apollo Client, and Zustand.

Table of Contents

• We Chat
  • Table of Contents
  • Features
  • Installation
  • Usage
  • Technologies Used
  • Contributing
  • License

Features

• Private messaging: Communicate securely with other users through private messages.
• Group chats: Create and participate in group chats with multiple users.
• Authentication: Secure authentication system to protect user data and privacy.
• Real-time updates: Utilize GraphQL subscriptions for real-time messaging updates.
• State management: Zustand is used for efficient state management within the application.

Installation

1. Clone the repository:

git clone https://github.com/mogobanyamwaro/we-chat.git

2. Navigate into the project directory:

cd we-chat

3. Install dependencies:

npm install

4. Set up the environment variables:

Create a .env file in the root directory and add necessary variables.

5. Start the development server:

npm start

6. Open the application in your web browser:

Access We Chat at http://localhost:3000 in your preferred web browser.

Usage

Once the application is running, sign in with your credentials to start sending private messages, creating or joining group chats, and enjoying real-time updates with other users.

Technologies Used

• React
• TypeScript
• GraphQL
• Redis
• PostgreSQL
• Nest.js
• Apollo Client
• Zustand

Contributing

Contributions are welcome! Please fork the repository and create a pull request with your enhancements.

License

This project is licensed under the MIT License.