Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ngquyduc committed Sep 1, 2023
1 parent 229cccd commit 80273a3
Show file tree
Hide file tree
Showing 4 changed files with 77 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,4 @@ yarn-error.log*
# typescript
*.tsbuildinfo
next-env.d.ts
.env
76 changes: 76 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Messenger Clone

## Tech Stack

- Next 13 (App Router)
- React
- Tailwind
- Prisma
- MongoDB
- Pusher

## Screenshots

![](public/screenshots/login.png)
_Log In Screen_

![](public/screenshots/main.png)
_Conversation Screen_

## Key features

### 1. Real-time Communication:

- Utilizes Pusher for instant messaging
- Provides message notifications and alerts

### 2. User Interface:

- Incorporates Tailwind design for a modern and stylish UI
- Employs Tailwind animations and transitions for engaging visuals
- Ensures full responsiveness across various devices

### 3. Authentication Options:

- Implements credential authentication via NextAuth
- Integrates Google authentication

### 4. Media Handling:

- Enables seamless file and image uploads through Cloudinary CDN
- Utilizes react-hook-form for client-side form validation and handling

### 5. Error Management:

- Utilizes react-toast for effective server error handling

### 6. Enhanced Messaging Experience:

- Provides message read receipts for tracking message status
- Indicates user online/offline status for real-time interaction

### 7. Diverse Communication:

- Supports both group chats and one-on-one messaging
- Enables message attachments and file sharing

### 8. Personalization:

- Offers user profile customization and settings

## What I've learnt

### 1. Backend Development:

- Demonstrates creating POST, GET, and DELETE routes in route handlers (app/api)
- Explores establishing relations between server and child components in a real-time environment

### 2. Database Interaction:

- Explains how to directly fetch data in server React components, bypassing APIs

### 3. Real-time Chat Management:

- Covers the creation and management of chat rooms and channels for dynamic interactions

[Back To The Top](#Messenger-Clone)
Binary file added public/screenshots/login.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/screenshots/main.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

1 comment on commit 80273a3

@vercel
Copy link

@vercel vercel bot commented on 80273a3 Sep 1, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.