Skip to content

Commit dc90b3e

Browse files
authored
Update README.md
1 parent 50d2ddd commit dc90b3e

1 file changed

Lines changed: 71 additions & 23 deletions

File tree

README.md

Lines changed: 71 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,84 @@
1-
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
1+
<div align="center">
2+
<h1>💬 MyMessenger - Frontend Demo</h1>
3+
<p>Explore the clean and interactive frontend of a messaging app with dark mode, responsive layout, and persistent local storage using IndexedDB. Built with Next.js, React, and TypeScript.</p>
4+
<a href="https://hamiparsa.github.io/My-Messenger/">
5+
<img src="https://img.shields.io/badge/View_Live_Project-000?style=for-the-badge&logo=github&logoColor=white"/>
6+
</a>
7+
</div>
28

3-
## Getting Started
9+
---
410

5-
First, run the development server:
11+
## 🔥 About MyMessenger
612

7-
```bash
8-
npm run dev
9-
# or
10-
yarn dev
11-
# or
12-
pnpm dev
13-
# or
14-
bun dev
15-
```
13+
**MyMessenger** is a sleek, frontend-only messaging app that uses **Next.js**, **React**, and **TypeScript** for a modern chat experience.
14+
With features like message persistence, image attachments, emoji picker, and typing indicator, this demo simulates a real-time messaging experience entirely on the client-side.
1615

17-
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
16+
The app utilizes **IndexedDB** for local message and image storage, so your messages persist even after page reloads.
1817

19-
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
18+
---
2019

21-
This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
20+
## 🚀 Features
2221

23-
## Learn More
22+
<ul>
23+
<li>🎨 <b>Dark Theme</b> — polished dark UI with smooth animations</li>
24+
<li>📱 <b>Responsive Design</b> — optimized for mobile, tablet, and desktop</li>
25+
<li>📧 <b>Message Persistence</b> — store messages and images locally in IndexedDB</li>
26+
<li>🖼️ <b>Image Attachments</b> — upload and preview images before sending</li>
27+
<li>😎 <b>Emoji Picker</b> — easily insert emojis into messages</li>
28+
<li>⏳ <b>Typing Indicator</b> — shows typing status while typing a message</li>
29+
<li>🖱️ <b>Interactive Contact List</b> — easily switch between chats</li>
30+
<li>🔄 <b>Auto-Reply Simulation</b> — simulate receiving a reply after a delay</li>
31+
</ul>
2432

25-
To learn more about Next.js, take a look at the following resources:
33+
---
2634

27-
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
28-
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
35+
## 🧠 Tech Stack
2936

30-
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
37+
| Technology | Purpose |
38+
|------------|---------|
39+
| ⚛️ **React** | Dynamic UI and chat logic |
40+
| 🧭 **Next.js** | File-based routing & optimization |
41+
| 🟦 **TypeScript** | Type safety and structured code |
42+
| 🎨 **Tailwind CSS** | Styling and responsive design |
43+
| 🗂️ **IndexedDB** | Persistent local storage for messages and images |
44+
| 😎 **react-icons** | Small, clean icons for UI elements |
45+
| 💬 **Next.js Client Component** | Entire app built as a client-side component |
3146

32-
## Deploy on Vercel
47+
---
3348

34-
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
49+
## 💡 Description
50+
51+
Users can:
52+
53+
- Switch between contacts and view individual chat windows 🖱️
54+
- Send text messages and upload images with previews 🖼️
55+
- All chat history, including images, is stored in the browser using **IndexedDB** for persistence 🔄
56+
- Use the built-in **emoji picker** to enhance messages 😎
57+
- See a **typing indicator** when the user is typing ⏳
58+
- Interact with the UI in a smooth, responsive experience 💬
59+
60+
This project demonstrates **modern front-end techniques** with persistent local storage, UI interactivity, and responsive design.
61+
62+
---
63+
64+
## 🖼️ Project Preview
65+
66+
<div align="center">
67+
<img src="/pic1.png" width="700px" />
68+
<br/> <br/>
69+
<img src="/pic2.png" width="700px" />
70+
</div>
71+
72+
---
73+
74+
## 👨‍💻 Author
75+
76+
**Developed by:** [Your Name](https://github.com/hamiparsa)
77+
💬 Front-End Developer | Building interactive, immersive web experiences
78+
79+
---
80+
81+
<div align="center">
82+
<img src="https://skillicons.dev/icons?i=react,next,typescript,tailwind,framer" />
83+
</div>
3584

36-
Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.

0 commit comments

Comments
 (0)