Skip to content

Commit 05dcaa4

Browse files
Update README.md
1 parent 540d014 commit 05dcaa4

File tree

1 file changed

+12
-21
lines changed

1 file changed

+12
-21
lines changed

README.md

+12-21
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# 📱 React-Chat-App
22

3-
Welcome to the **React-Chat-App**! This is a real-time chat application built with React, Firebase, and Firestore. The app leverages Zustand for state management and Tailwind CSS for styling. It's deployed using Vercel.
3+
Welcome to the **React-Chat-App**! This is a real-time chat application built with React, Firebase, and Firestore. The app leverages Zustand for state management and Tailwind CSS for styling. It's deployed using Firebase Hosting.
44

55
## 🚀 Features
66

@@ -17,8 +17,7 @@ Welcome to the **React-Chat-App**! This is a real-time chat application built wi
1717
- **Firestore**: NoSQL document database built for automatic scaling
1818
- **Zustand**: Small, fast, and scalable state management solution
1919
- **Tailwind CSS**: Utility-first CSS framework for rapid UI development
20-
- **Vercel**: Deployment and serverless functions
21-
20+
- **Firebase Hosting**: Fast and secure web hosting for static and dynamic content
2221

2322
## 🏃‍♂️ Getting Started
2423

@@ -35,11 +34,12 @@ Follow these steps to get a local copy of the project up and running.
3534

3635
```sh
3736
git clone https://github.com/utsavpatel562/React-Chat-App.git
38-
React-Chat-App
37+
cd React-Chat-App
3938
npm install
4039

41-
### Firebase Config
42-
<code>
40+
### Configure Firebase
41+
<p>Create a .env file in the root directory and add your Firebase configuration:</p>
42+
<code stlye="padding:3px;">
4343
REACT_APP_API_KEY=your-api-key
4444
REACT_APP_AUTH_DOMAIN=your-auth-domain
4545
REACT_APP_PROJECT_ID=your-project-id
@@ -48,24 +48,15 @@ REACT_APP_MESSAGING_SENDER_ID=your-messaging-sender-id
4848
REACT_APP_APP_ID=your-app-id
4949
</code>
5050

51-
<br>npm start
52-
53-
The app should now be running on http://localhost:3000.
54-
5551
### Contributing
56-
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
57-
58-
<ul shape="number">
59-
<li>Fork the Project</li>
60-
<li>Create your Feature Branch (git checkout -b feature/AmazingFeature)</li>
61-
<li>Commit your Changes (git commit -m 'Add some AmazingFeature')</li>
62-
<li>Push to the Branch (git push origin feature/AmazingFeature)</li>
63-
<li>Open a Pull Request</li>
64-
</ul>
52+
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.<br>
53+
<code>git checkout -b feature/AmazingFeature</code>
54+
<code>git commit -m 'Add some AmazingFeature'</code>
55+
<code>git push origin feature/AmazingFeature</code>
6556

6657
### 📧 Contact
67-
Utsav Patel - utsavpatel562@gmail.com<br>
68-
Project Link: https://github.com/utsavpatel562/React-Chat-App
58+
Utsav Patel - utsavpatel562@gmail.com
59+
<br>Project Link: https://github.com/utsavpatel562/React-Chat-App
6960

7061
### 📝 License
7162
Distributed under the MIT License. <br>See LICENSE for more information.

0 commit comments

Comments
 (0)