File size: 8,894 Bytes
f5071ca |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 |
<div align="center">
<img src="https://user-images.githubusercontent.com/99184393/195982647-048bc778-f82d-427c-b28b-78b1156d158d.png" alt="logo" width="205" height="auto" />
<h1>Instagram Clone with React.JS</h1>
<p>
Instagram 2.0 with REACT.JS! (Next.js, NextAuth.js v4.17.0, Tailwind CSS, Firebase v9, Image Uploading, Google Authentication,, Instagram Profile)
</p>
<!-- Badges -->
<a href="https://projects-seven-peach.vercel.app" target="_blank"></a>
<h4>
<a href="https://projects-seven-peach.vercel.app">View Demo</a>
<span> 路 </span>
<a href="https://github.com/SashenJayathilaka/Instagram-Clone/blob/master/README.md">Documentation</a>
<span> 路 </span>
<a href="https://github.com/SashenJayathilaka/Instagram-Clone/issues">Report Bug</a>
<span> 路 </span>
<a href="https://github.com/SashenJayathilaka/Instagram-Clone/issues">Request Feature</a>
</h4>
</div>
<br />
<!-- Table of Contents -->
## :notebook_with_decorative_cover: Table of Contents
- [About the Project](#star2-about-the-project)
- [Screenshots](#camera-screenshots)
- [Tech Stack](#space_invader-tech-stack)
- [Environment Variables](#key-environment-variables)
- [Getting Started](#toolbox-getting-started)
- [Prerequisites](#bangbang-prerequisites)
- [Installation](#gear-installation)
- [Run Locally](#running-run-locally)
- [Deployment](#triangular_flag_on_post-deployment)
- [Contact](#handshake-contact)
<!-- About the Project -->
## :star2: About the Project
<!-- Screenshots -->
### :camera: Screenshots
<div align="center">
<a href="https://projects-seven-peach.vercel.app/" target="_blank"><img src='https://user-images.githubusercontent.com/99184393/188783926-2478a323-2472-4b4e-ae49-583e88700848.gif' alt='image'/></a>
</div>
## <a href="https://projects-seven-peach.vercel.app" target="_blank">LIVE DEMO 馃挜</a>
### :space_invader: Tech Stack
<details>
<summary>Client</summary>
<ul>
<li><a href="https://#/">Typescript</a></li>
<li><a href="https://nextjs.org/">Next.js</a></li>
<li><a href="https://reactjs.org/">React.js</a></li>
<li><a href="https://tailwindcss.com/">TailwindCSS</a></li>
</ul>
</details>
<details>
<summary>Database</summary>
<ul>
<li><a href="https://firebase.google.com">Firebase</a></li>
</ul>
</details>
<br />
<table>
<tr>
<td>
<a href="#"><img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/react/react-original.svg" alt="" width="30" height="30" /></a>
</td>
<td>
<a href="#"><img src="https://user-images.githubusercontent.com/99184393/183096870-fdf58e59-d78c-44f4-bd1c-f9033c16d907.png" alt="Google" width="30" height="30" /></a>
</td>
<td>
<a href="#"><img src="https://user-images.githubusercontent.com/99184393/179383376-874f547c-4e6f-4826-850e-706b009e7e2b.png" alt="" width="30" height="30" /></a>
</td>
<td>
<a href="#"><img src="https://user-images.githubusercontent.com/99184393/180462270-ea4a249c-627c-4479-9431-5c3fd25454c4.png" alt="" width="30" height="30" /></a>
</td>
<td>
<a href="#"><img src="https://user-images.githubusercontent.com/99184393/177784603-d69e9d02-721a-4bce-b9b3-949165d2edeb.png" alt="" width="30" height="30" /></a>
</td>
<td>
<a href="#"><img src="https://user-images.githubusercontent.com/99184393/204170976-0e5c6e2a-2b41-483d-adbd-d5d1e40b8d15.png" alt="" width="30" height="30" /></a>
</td>
<td>
<a href="#"><img src="https://raw.githubusercontent.com/atulmy/oauth/master/web/public/images/social/instagram.svg" alt="" width="30" height="30" /></a>
</td>
</tr>
</table>
## :toolbox: Getting Started
### :bangbang: Prerequisites
- Sign up for a Firebase account <a href='https://firebase.google.com'>HERE</a>
- Install Node JS in your computer <a href='https://nodejs.org/en/'>HERE</a>
<!-- Env Variables -->
### :key: Environment Variables
To run this project, you will need to add the following environment variables to your .env file
`NEXTAUTH_URL`
`GOOGLE_CLIENT_ID`
`NEXT_PUBLIC_SECRET`
`GOOGLE_CLIENT_SECRET`
`NEXT_PUBLIC_BASE_URL`
`NEXT_PUBLIC_FIREBASE_APP_ID`
`NEXT_PUBLIC_FIREBASE_API_KEY`
`NEXT_PUBLIC_FIREBASE_PROJECT_ID`
`NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN`
`NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET`
`NEXT_PUBLIC_FIREBASE_MESSAGING_SET`
### :gear: Installation
Install my-project with npm
```
npx create-next-app instagram_clone
```
```
cd instagram_clone
```
Install dependencies
### :test_tube: Install Tailwind CSS with Next.js
#### Install Tailwind CSS
Install tailwindcss and its peer dependencies via npm, and then run the init command to generate both `tailwind.config.js` and `postcss.config.js`.
```
npm install -D tailwindcss postcss autoprefixer
```
```
npx tailwindcss init -p
```
#### Configure your template paths
Add the paths to all of your template files in your `tailwind.config.js` file.
<br>
```
module.exports = {
content: [
"./pages/**/*.{js,ts,jsx,tsx}",
"./components/**/*.{js,ts,jsx,tsx}",
],
theme: {
extend: {},
},
plugins: [],
}
```
#### Add the Tailwind directives to your CSS
Add the `@tailwind` directives for each of Tailwind鈥檚 layers to your `./styles/globals.css` file.
```
@tailwind base;
@tailwind components;
@tailwind utilities;
```
Install dependencies
<a href="https://github.com/SashenJayathilaka/Instagram-Clone/blob/master/package.json" target="_blank">馃敹 Other Dependency Info</a>
<!-- Run Locally -->
### :running: Run Locally
Clone the project
```bash
git clone https://github.com/SashenJayathilaka/Instagram-Clone.git
```
Install dependencies
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
```bash
npm install
```
## Getting Started
Start the server
First, run the development server:
```bash
npm run dev
```
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file.
[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.js`.
The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
### Learn More
To learn more about Next.js, take a look at the following resources:
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
<!-- Deployment -->
### :triangular_flag_on_post: Deployment
To deploy this project run
##### Deploy on Vercel
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.
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
## :handshake: Contact
Your Name - [@twitter_handle](https://twitter.com/SashenHasinduJ) - sashenjayathilaka95@gmail.com
Project Link: [https://github.com/SashenJayathilaka/Instagram-Clone.git](https://github.com/SashenJayathilaka/Instagram-Clone.git)
<hr />
<div align="center">
<a href="https://projects-seven-peach.vercel.app/" target="_blank"><img src='https://user-images.githubusercontent.com/99184393/195737045-7c3e9b89-b961-4bc5-9d69-61d2a76176ea.png' alt='image'/></a>
</div>
<br />
<div align="center">Don't forget to leave a star 猸愶笍</div>
|