Skip to content

Commit 6637516

Browse files
authored
Merge pull request #2 from saddamarbaa/docs/update-docs-and-add-license
Docs/update docs and add license
2 parents a76a337 + 6a64c9b commit 6637516

File tree

2 files changed

+169
-110
lines changed

2 files changed

+169
-110
lines changed

LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2021 saddamarbaa
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

+148-110
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,46 @@
1+
# Pinterest Clone App
12

2-
## Pinterest Clone
3+
Building Pinterest Clone App with React Js, TypeScript, Redux, Styled Component,
4+
Firebase, Vercel Hosting, with complete user authentication (a mobile-friendly).
35

4-
Building Pinterest Clone App with React Js, Styled Component,
5-
React Context API, Material-UI, Google Authentication, Firebase Hosting,
6-
Firebase Realtime Database, (a mobile-friendly)
7-
8-
9-
## Table of contents
10-
* [Author](#Author)
11-
* [Demo](#Demo)
12-
* [Tech Stack](#Technologies)
13-
* [Optimizations](#Optimizations)
14-
* [Contributing](#Contributing)
15-
* [Features](#features)
16-
* [Status](#status)
17-
* [Inspiration](#inspiration)
18-
* [Support](#Support)
19-
* [Screenshots](#Screenshots)
20-
* [Support](#Support)
21-
* [Feedback](#Feedback)
226

7+
# Table of contents
238

24-
25-
### Author
9+
- [Author](#Author)
10+
- [Demo](#Demo)
11+
- [Technologies](#Technologies)
12+
- [Features](#Features)
13+
- [Related Projects](#Related_Projects)
14+
- [Contributing](#Contributing)
15+
- [Status](#status)
16+
- [Inspiration](#inspiration)
17+
- [Support](#Support)
18+
- [Feedback](#Feedback)
19+
- [Run Locally](#Run_Locally)
20+
- [Environment Variables](#Environment)
21+
- [Deployment](#Deployment)
22+
- [Screenshots](#Screenshots)
2623

27-
- [@Saddam Arbaa](https://github.com/saddamarbaa)
2824

25+
# Author
2926

30-
### Contributing
27+
### <a href="https://github.com/saddamarbaa">@Saddam Arbaa</a>
3128

32-
Contributions are always welcome!
29+
30+
31+
# Technologies
32+
33+
**Client:**
34+
35+
- React Js (class based components)
36+
- TypeScript
37+
- Styled Component
38+
- React Context API
39+
40+
**Server:**
41+
42+
- Vercel Hosting
43+
- Firebase Google Authentication
3344

3445

3546

@@ -40,36 +51,107 @@ Contributions are always welcome!
4051
### <a href="https://www.loom.com/share/59bd9d98bd2645c89f12ffcff122b98f"> Live Video Demo </a>
4152

4253

43-
### Technologies
4454

45-
**Client:** React, React Context API, Material-UI, Styled Component
55+
# Related_Projects
56+
57+
58+
### LinkedIn Clone App built with React Js + TypeScript + Redux + Styled Components + Material-UI + Firebase Realtime Database + Vercel Hosting
59+
60+
### <a href="https://github.com/saddamarbaa/LinkedIn-clone-app-react-typescript"> Github Repo </a>
61+
### <a href="https://linkedin-clone-app-navy.vercel.app/">LIVE DEMO</a>
62+
63+
64+
### Instagram Clone App built with React Js + Next Js + TypeScript + Redux + Tailwind CSS + Heroicons
65+
66+
### <a href="https://github.com/saddamarbaa/Instagram-clone-app-nex-js"> Github Repo </a>
67+
68+
### <a href="https://instagram-clone-app-nex-js.vercel.app/">LIVE DEMO</a>
69+
70+
71+
### Facebook Clone App built with React Js + Next Js + TypeScript + Redux + Styled Components
72+
### <a href="https://github.com/saddamarbaa/facebook-clone-app-nex-js"> Github Repo </a>
73+
### <a href="https://facebook-clone-app-nex-js.vercel.app/">LIVE DEMO</a>
74+
75+
76+
### Messenger Clone App built with React Js + Next Js + Redux + Styled Components + Material-UI
77+
### <a href="https://github.com/saddamarbaa/messenger-clone-app-nex-js"> Github Repo </a>
78+
### <a href="https://messenger-clone-app-nex-js.vercel.app/">LIVE DEMO</a>
79+
80+
81+
### Gmail Clone App built with React Js + Next Js + TypeScript + Styled Components + Material-UI + Firebase Realtime Database + Vercel Hosting
82+
83+
### <a href="https://github.com/saddamarbaa/Gmail-clone-app-nex-js"> Github Repo </a>
84+
### <a href="https://gmail-clone-app.vercel.app/">LIVE DEMO</a>
85+
86+
87+
### Signal Clone App built with React Native + TypeScript + Expo + React Navigation + Firebase Realtime Database + User Authentication + Passwordless Authentication with Magic Link
88+
89+
### <a href="https://github.com/saddamarbaa/signal-clone-app-reactnative-typescript"> Github Repo </a>
90+
91+
92+
### WhatsApp Clone App built with React Js + React Context API + Styled Components + Material-UI + Firebase Realtime Database + Firebase Hosting
93+
94+
### <a href="https://github.com/saddamarbaa/whatsapp-clone"> Github Repo </a>
95+
96+
### <a href="https://whatsapp-clone-pwj.web.app/">LIVE DEMO</a>
97+
98+
99+
### Slack Clone App built with React Js + Next Js + Styled Components + firebase-hooks + Material-UI
100+
101+
### <a href="https://github.com/saddamarbaa/slack-clone-app-nex-js"> Github Repo </a>
102+
103+
### <a href="https://slack-clone-app-nex-js.vercel.app/">LIVE DEMO</a>
104+
105+
106+
### Airbnb Clone App built with React Js + Next Js + Redux + Tailwind CSS
107+
108+
### <a href="https://github.com/saddamarbaa/airbnb-clone-app-nex-js"> Github Repo </a>
109+
110+
### <a href="https://airbnb-clone-app-nex-js.vercel.app/">LIVE DEMO</a>
111+
112+
### Amazon Clone App built with React Js + TypeScript + Redux + Styled Components
113+
114+
### <a href="https://github.com/saddamarbaa/amazon-clone-app-react-typescript"> Github Repo </a>
46115

47-
**Server:** Firebase Realtime Database, Firebase Hosting, Firebase Google Authentication
116+
### <a href="https://amazon-clone-murex-six.vercel.app/">LIVE DEMO</a>
48117

49118

50-
### Features
119+
### Tesla Clone App built with React Js + TypeScript + Redux + Styled Components + Material-UI + Vercel Hosting
120+
121+
### <a href="https://github.com/saddamarbaa/tesla-clone-app-react-typescript"> Github Repo </a>
122+
### <a href="https://tesla-clone-app-neon.vercel.app/">LIVE DEMO</a>
123+
124+
125+
### Netflix Clone App built with React Js + TypeScript + Redux + Stripe Checkout/Payments + Vercel Hosting + Firebase
126+
127+
### <a href="https://github.com/saddamarbaa/netflix-clone-app-react-typescript"> Github Repo </a>
128+
### <a href="https://netflix-clone-app-react-typescript.vercel.app/">LIVE DEMO</a>
129+
130+
131+
132+
133+
134+
# Features
51135

52136
- Search functionality
53137
- Google Authentication
54138

55139

56-
## Optimizations
57-
- function components
58-
- React hooks
59-
- React useEffect cleanup
60140

141+
# Contributing
61142

143+
Contributions are always welcome!
62144

63-
### Support
145+
146+
# Support
64147

65148
For support, email [email protected].
66149

67150

68-
### Feedback
151+
# Feedback
69152

70153
If you have any feedback, please reach out to me at [email protected]
71154

72-
73155
Twitter
74156
https://twitter.com/ArbaaSaddam/
75157

@@ -86,39 +168,19 @@ Facebook
86168
https://www.facebook.com/saddam.arbaa
87169

88170

89-
90-
### Screenshots
91-
92-
### responsive on large screens
93-
94-
![image](https://user-images.githubusercontent.com/51326421/121102612-36e29c80-c828-11eb-9812-63401a44d81a.png)
95-
96-
97-
### responsive on small screens
98-
99-
![image](https://user-images.githubusercontent.com/51326421/121106925-30a4ee00-c831-11eb-9849-91b5462d6e82.png)
100-
101-
102171

103-
### Sign in page
104-
105-
![image](https://user-images.githubusercontent.com/51326421/121102842-ca1bd200-c828-11eb-85b3-4b55885be8fc.png)
106-
107-
108-
109-
110-
### Run Locally
172+
# Run_Locally
111173

112174
Clone the project
113175

114176
```bash
115-
git clone https://github.com/saddamarbaa/pinterest-clone.git
177+
git clone https://github.com/saddamarbaa/pinterest-clone-app-react-typescript
116178
```
117179

118180
Go to the project directory
119181

120182
```bash
121-
cd pinterest-clone
183+
cd pinterest-clone-app-react-typescript
122184
```
123185

124186
Install dependencies
@@ -130,85 +192,61 @@ Install dependencies
130192
Start the server
131193

132194
```bash
133-
npm start
195+
npm start
134196

135197

136198
```
137199

138-
### Status
139-
Project is: _in progress_
140-
I'm working on it in my free time
141-
142-
### Inspiration
143-
Build By Saddam Arbaa Project inspired by [Pinterest] https://id.pinterest.com/
144-
145-
# Getting Started with Create React App
146-
147-
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
200+
# Environment
148201

149-
## Available Scripts
202+
- To run this project, you will need to create a new project on firebase, setup Firebase Realtime Database and add the following environment variables to your .env file
150203

151-
In the project directory, you can run:
204+
- REACT_APP_FIREBASE_API_KEY
205+
- REACT_APP_AUTH_DOMAIN
206+
- REACT_APP_STORAGE_BUCKET
207+
- REACT_APP_PROJECT_ID
208+
- REACT_APP_MESSAIN_SENDER_ID
209+
- REACT_APP_APPID
152210

153-
### `npm start`
154211

155-
Runs the app in the development mode.\
156-
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
212+
# Status
157213

158-
The page will reload if you make edits.\
159-
You will also see any lint errors in the console.
160-
161-
### `npm test`
162-
163-
Launches the test runner in the interactive watch mode.\
164-
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
165-
166-
### `npm run build`
167-
168-
Builds the app for production to the `build` folder.\
169-
It correctly bundles React in production mode and optimizes the build for the best performance.
170-
171-
The build is minified and the filenames include the hashes.\
172-
Your app is ready to be deployed!
214+
Project is: _in progress_
215+
I'm working on it in my free time
173216

174-
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
175217

176-
### `npm run eject`
218+
# Inspiration
177219

178-
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
220+
Build By Saddam Arbaa Project inspired by [Pinterest] https://id.pinterest.com/
179221

180-
If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
181222

182-
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
183223

184-
You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
224+
# Deployment
185225

186-
## Learn More
226+
To deploy this project on firebase Flow the firebase documentation <a href="https://firebase.google.com/docs">Firebase Documentation</a>
187227

188-
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
228+
- create a new project on firebase
229+
- npm install -g firebase-tools
230+
- firebase init
231+
- npm run build
232+
- firebase deploy
189233

190-
To learn React, check out the [React documentation](https://reactjs.org/).
191234

192-
### Code Splitting
193235

194-
This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
195236

196-
### Analyzing the Bundle Size
237+
# Screenshots
197238

198-
This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
199239

200-
### Making a Progressive Web App
240+
## Log in Page
241+
![Screenshot 2022-11-11 at 08-41-18 Pinterest](https://user-images.githubusercontent.com/51326421/201243704-67916c82-8b5a-4c80-8116-bc6fc90910b4.png)
201242

202-
This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
203243

204-
### Advanced Configuration
244+
## responsive on large screens
205245

206-
This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
246+
![image](https://user-images.githubusercontent.com/51326421/121102612-36e29c80-c828-11eb-9812-63401a44d81a.png)
207247

208-
### Deployment
209248

210-
This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
249+
## responsive on small screens
211250

212-
### `npm run build` fails to minify
251+
![Screenshot 2022-11-11 at 00-40-02 Pinterest Clone App](https://user-images.githubusercontent.com/51326421/201243914-c5d74180-d772-4d07-aab1-c96a67db5a84.png)
213252

214-
This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)

0 commit comments

Comments
 (0)