Skip to content

Commit 179fb80

Browse files
📄 Add LEARN
1 parent 9f0d818 commit 179fb80

File tree

1 file changed

+306
-0
lines changed

1 file changed

+306
-0
lines changed

LEARN.md

+306
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,306 @@
1+
<div align="center">
2+
3+
<img src="https://user-images.githubusercontent.com/99184393/223374639-56c53106-86d4-4a36-be0b-6507ce869119.png" alt="logo" width="200" height="auto" />
4+
5+
<h1>Full Stack Movie Application with NEXT.JS 13!</h1>
6+
7+
<p>
8+
Full Stack Movie Application with NEXT.JS 13!(Next.js 13, mongodb, node js, NextAuth.js v4, Tailwind CSS, framer-motion, TMDB Api, Google Authentication, primary information about a movies, Users can Add Bookmark in favorite actors and movies).
9+
</p>
10+
11+
<!-- Badges -->
12+
13+
<a href="https://movie-sapp.netlify.app" target="_blank">![](https://img.shields.io/website-up-down-green-red/http/monip.org.svg)</a>
14+
![](https://img.shields.io/badge/Maintained-Yes-indigo)
15+
![](https://img.shields.io/github/forks/SashenJayathilaka/Full-Stack-Movie-Application.svg)
16+
![](https://img.shields.io/github/stars/SashenJayathilaka/Full-Stack-Movie-Application.svg)
17+
![](https://img.shields.io/github/issues/SashenJayathilaka/Full-Stack-Movie-Application)
18+
![](https://img.shields.io/github/last-commit/SashenJayathilaka/Full-Stack-Movie-Application)
19+
20+
<h4>
21+
<a href="https://movie-sapp.netlify.app">View Demo</a>
22+
<span> · </span>
23+
<a href="https://github.com/SashenJayathilaka/Movie-App/blob/master/README.md">Documentation</a>
24+
<span> · </span>
25+
<a href="https://github.com/SashenJayathilaka/Movie-App/issues">Report Bug</a>
26+
<span> · </span>
27+
<a href="https://github.com/SashenJayathilaka/Movie-App/issues">Request Feature</a>
28+
</h4>
29+
</div>
30+
31+
<br />
32+
33+
<!-- Table of Contents -->
34+
35+
## :notebook_with_decorative_cover: Table of Contents
36+
37+
- [About the Project](#star2-about-the-project)
38+
- [Screenshots](#camera-screenshots)
39+
- [Tech Stack](#space_invader-tech-stack)
40+
- [Environment Variables](#key-environment-variables)
41+
- [Getting Started](#toolbox-getting-started)
42+
- [Prerequisites](#bangbang-prerequisites)
43+
- [Installation](#gear-installation)
44+
- [Run Locally](#running-run-locally)
45+
- [Deployment](#triangular_flag_on_post-deployment)
46+
- [Contact](#handshake-contact)
47+
48+
<!-- About the Project -->
49+
50+
## :star2: About the Project
51+
52+
<!-- Screenshots -->
53+
54+
### :camera: Screenshots
55+
56+
- Application Home page & Demo
57+
58+
<div align="center">
59+
<a href="https://movie-sapp.netlify.app" target="_blank"><img src='./demo/ezgif-2-b23fb77da9.gif' alt='image'/></a>
60+
</div>
61+
62+
<br />
63+
64+
- Movie Details Page
65+
66+
<div align="center">
67+
<a href="https://movie-sapp.netlify.app" target="_blank"><img src='https://user-images.githubusercontent.com/99184393/223381897-a4e2a6bc-dda5-4c94-a79f-b12708dc57eb.png' alt='image' width='800'/></a>
68+
</div>
69+
70+
<br />
71+
72+
- User Profile Page
73+
74+
<div align="center">
75+
<a href="https://movie-sapp.netlify.app" target="_blank"><img src='https://user-images.githubusercontent.com/99184393/223382847-4e1000b5-1ae4-4ffd-a521-3ed95f616f38.png' alt='image' width='800'/></a>
76+
</div>
77+
78+
## <a href="https://movie-sapp.netlify.app" target="_blank">LIVE DEMO 💥</a>
79+
80+
![forthebadge](https://forthebadge.com/images/badges/built-with-love.svg)
81+
![forthebadge](https://forthebadge.com/images/badges/for-you.svg)
82+
![forthebadge](https://forthebadge.com/images/badges/powered-by-coffee.svg)
83+
84+
### :space_invader: Tech Stack
85+
86+
<details>
87+
<summary>Client</summary>
88+
<ul>
89+
<li><a href="https://#/">Typescript</a></li>
90+
<li><a href="https://nextjs.org/">Next.js</a></li>
91+
<li><a href="https://reactjs.org/">React.js</a></li>
92+
<li><a href="https://tailwindcss.com/">TailwindCSS</a></li>
93+
<li><a href="https://www.themoviedb.org">The Movie Database (TMDB)</a></li>
94+
</ul>
95+
</details>
96+
97+
<details>
98+
<summary>Server</summary>
99+
<ul>
100+
<li><a href="https://nodejs.org/en/">Node Js</a></li>
101+
<li><a href="https://expressjs.com/">express</a></li>
102+
<li><a href="https://www.mongodb.com/">mongoDB</a></li>
103+
<li><a href="https://railway.app/">Railway</a></li>
104+
</ul>
105+
</details>
106+
107+
<br />
108+
109+
<table>
110+
<tr>
111+
<td>
112+
<a href="#"><img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/react/react-original.svg" alt="" width="30" height="30" /></a>
113+
</td>
114+
<td>
115+
<a href="#"><img src="https://user-images.githubusercontent.com/99184393/183096870-fdf58e59-d78c-44f4-bd1c-f9033c16d907.png" alt="Google" width="30" height="30" /></a>
116+
</td>
117+
<td>
118+
<a href="#"><img src="https://user-images.githubusercontent.com/99184393/179383376-874f547c-4e6f-4826-850e-706b009e7e2b.png" alt="" width="30" height="30" /></a>
119+
</td>
120+
<td>
121+
<a href="#"><img src="https://user-images.githubusercontent.com/99184393/180462270-ea4a249c-627c-4479-9431-5c3fd25454c4.png" alt="" width="30" height="30" /></a>
122+
</td>
123+
<td>
124+
<a href="#"><img src="https://user-images.githubusercontent.com/99184393/181918664-569af962-756c-438c-b350-294f042e6f61.png" alt="" width="30" height="30" /></a>
125+
</td>
126+
<td>
127+
<a href="#"><img src="https://user-images.githubusercontent.com/99184393/204170976-0e5c6e2a-2b41-483d-adbd-d5d1e40b8d15.png" alt="" width="30" height="30" /></a>
128+
</td>
129+
</tr>
130+
</table>
131+
132+
## :toolbox: Getting Started
133+
134+
### :bangbang: Prerequisites
135+
136+
- Sign up for a The Movie Database (TMDB) account <a href='https://www.themoviedb.org'>HERE</a>
137+
- Install Node JS in your computer <a href='https://nodejs.org/en/'>HERE</a>
138+
- Create Account mongoDB <a href='https://www.mongodb.com/'>HERE</a>
139+
- Create Account Railway <a href='https://railway.app/'>HERE</a>
140+
- Get Lookup APi Key <a href='https://extreme-ip-lookup.com/'>HERE</a>
141+
- Pusher JS <a href='https://pusher.com/'>HERE</a>
142+
143+
<!-- Env Variables -->
144+
145+
### :key: Environment Variables
146+
147+
To run this project, you will need to add the following environment variables to your .env file
148+
149+
- Frontend
150+
151+
`NEXT_PUBLIC_API_KEY`
152+
153+
`GOOGLE_CLIENT_ID`
154+
155+
`GOOGLE_CLIENT_SECRET`
156+
157+
`NEXT_PUBLIC_SECRET`
158+
159+
`NEXTAUTH_URL`
160+
161+
`NEXT_PUBLIC_SERVER_URL`
162+
163+
`NEXT_PUBLIC_LOOKUP_KEY`
164+
165+
- Server
166+
167+
`MONGODB_URL`
168+
169+
`PUSHER_APPID`
170+
171+
`PUSHER_KEY`
172+
173+
`USHER_SECRET`
174+
175+
### :gear: Installation
176+
177+
Install my-project with npm
178+
179+
```bash
180+
npx create-next-app@latest my-project --typescript
181+
```
182+
183+
```
184+
cd my-project
185+
```
186+
187+
Install dependencies
188+
189+
### :test_tube: Install Tailwind CSS with Next.js
190+
191+
#### Install Tailwind CSS
192+
193+
Install tailwindcss and its peer dependencies via npm, and then run the init command to generate both `tailwind.config.js` and `postcss.config.js`.
194+
195+
```bash
196+
npm install -D tailwindcss postcss autoprefixer
197+
```
198+
199+
```bash
200+
npx tailwindcss init -p
201+
```
202+
203+
#### Configure your template paths
204+
205+
Add the paths to all of your template files in your `tailwind.config.js` file.
206+
<br>
207+
208+
```ts
209+
/** @type {import('tailwindcss').Config} */
210+
module.exports = {
211+
content: ["./app/**/*.{js,ts,jsx,tsx}", "./components/**/*.{js,ts,jsx,tsx}"],
212+
theme: {
213+
extend: {},
214+
},
215+
plugins: [],
216+
};
217+
```
218+
219+
#### Add the Tailwind directives to your CSS
220+
221+
Add the `@tailwind` directives for each of Tailwind’s layers to your `./styles/globals.css` file.
222+
223+
```css
224+
@tailwind base;
225+
@tailwind components;
226+
@tailwind utilities;
227+
```
228+
229+
Install dependencies
230+
231+
<a href="https://github.com/SashenJayathilaka/Full-Stack-Movie-Application/blob/master/package.json" target="_blank">🔶 Other Dependency Info</a>
232+
233+
<!-- Run Locally -->
234+
235+
### :running: Run Locally
236+
237+
Clone the project
238+
239+
```bash
240+
git clone https://github.com/SashenJayathilaka/Full-Stack-Movie-Application.git
241+
```
242+
243+
```bash
244+
cd Full-Stack-Movie-Application
245+
```
246+
247+
Install dependencies
248+
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).
249+
250+
```bash
251+
npm install
252+
```
253+
254+
Start the server
255+
First, run the development server:
256+
257+
```bash
258+
npm run dev
259+
```
260+
261+
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).
262+
263+
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
264+
265+
You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file.
266+
267+
[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.ts`.
268+
269+
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.
270+
271+
### Learn More
272+
273+
This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
274+
275+
<!-- Deployment -->
276+
277+
### :triangular_flag_on_post: Deployment
278+
279+
To deploy this project run
280+
281+
##### Frontend
282+
283+
##### Deploy on Netlify
284+
285+
The easiest way to deploy your Next.js app is to use the [Netlify Platform](https://app.netlify.com/) from the creators of Next.js.
286+
287+
Check out our [Netlify deployment documentation](https://docs.netlify.com/) for more details.
288+
289+
##### Backend (server)
290+
291+
##### Deploy on Railway
292+
293+
The easiest way to deploy your server is to use the [Railway Platform](https://railway.app/) from the creators of Next.js.
294+
295+
Check out our [Railway deployment documentation](https://docs.railway.app/deploy/deployments) for more details.
296+
297+
## :handshake: Contact
298+
299+
Your Name - [@twitter_handle](https://twitter.com/SashenHasinduJ) - [email protected]
300+
301+
Project Link: [https://github.com/SashenJayathilaka/Full-Stack-Movie-Application.git](https://github.com/SashenJayathilaka/Full-Stack-Movie-Application.git)
302+
303+
<hr />
304+
<br />
305+
306+
<div align="center">Don't forget to leave a star ⭐️</div>

0 commit comments

Comments
 (0)