|
| 1 | +<br/> |
| 2 | +<p align="center"> |
| 3 | +<a href="https://github.com/Kaushik612/reviews.io"> |
| 4 | + <img src="images/banner-1.jpg" alt="Logo" width="80" height="80"> |
| 5 | + </a> |
| 6 | + <h3 align="center">Reviews.io</h3> |
| 7 | + |
| 8 | + <p align="center"> |
| 9 | + A Modern website which accumulates crowd-sourced reviews about restaurants |
| 10 | + <br/> |
| 11 | + </p> |
| 12 | +</p> |
| 13 | + |
| 14 | +   |
| 15 | + |
| 16 | +## Table Of Contents |
| 17 | + |
| 18 | +- [Screenshots](#screenshots) |
| 19 | +- [About the Project](#about-the-project) |
| 20 | +- [Built With](#built-with) |
| 21 | +- [Getting Started](#getting-started) |
| 22 | + - [Prerequisites](#prerequisites) |
| 23 | + - [Installation](#installation) |
| 24 | +- [License](#license) |
| 25 | +- [Authors](#authors) |
| 26 | + |
| 27 | +## Screenshots |
| 28 | + |
| 29 | + |
| 30 | + |
| 31 | + |
| 32 | + |
| 33 | + |
| 34 | + |
| 35 | + |
| 36 | + |
| 37 | + |
| 38 | + |
| 39 | + |
| 40 | + |
| 41 | + |
| 42 | + |
| 43 | +## About The Project |
| 44 | + |
| 45 | +A Modern website for reviewing your favorite Restaurants and checking out reviews from other customers. |
| 46 | + |
| 47 | +The idea behind building this website is to get a good understanding of developing a fully functional Full stack application using Next.js framework and MongoDB as a backend database. |
| 48 | + |
| 49 | +This application is built using all the new Next.js 13 features and also features TypeScript which makes everything just better! |
| 50 | + |
| 51 | +I use Clerk for authentication which I feel makes setting up auth for your Next.js projects a breeze. |
| 52 | + |
| 53 | +### Built With |
| 54 | + |
| 55 | +- [![Next][Next.js]][Next-url] |
| 56 | +- [![React][React.js]][React-url] |
| 57 | +- [![Tailwind][Tailwind.css]][Tailwind-url] |
| 58 | +- [![Typescript][Typescript]][Typescript-url] |
| 59 | +- [![Prisma][Prisma]][Prisma-url] |
| 60 | +- [![MongoDB][MongoDB]][MongoDB-url] |
| 61 | + |
| 62 | +### Features: |
| 63 | + |
| 64 | +- Tailwind design and Framer-motion animations |
| 65 | +- Fully Responsive |
| 66 | +- Clerk Authentication (Email, Google, 9+ Social Logins) |
| 67 | +- Client form validation and handling using react-hook-form & zod |
| 68 | +- Server error handling using react-toast |
| 69 | +- Page loading state |
| 70 | +- How to write POST, DELETE, and GET routes in route handlers (app/api) |
| 71 | +- How to fetch data in server react components by directly accessing database (WITHOUT API! like Magic!) |
| 72 | +- How to handle relations between Server and Child components! |
| 73 | +- How to reuse layouts |
| 74 | +- Folder structure in Next 13 App Router |
| 75 | +- Sample About and Contact page that can be expanded as required |
| 76 | + |
| 77 | +<p align="right">(<a href="#readme-top">back to top</a>)</p> |
| 78 | + |
| 79 | +## Getting Started |
| 80 | + |
| 81 | +### Prerequisites |
| 82 | + |
| 83 | +**Node version 18.x.x** |
| 84 | + |
| 85 | +### Cloning the repository |
| 86 | + |
| 87 | +```shell |
| 88 | +git clone https://github.com/Kaushik612/reviews.io.git |
| 89 | +``` |
| 90 | + |
| 91 | +### Install packages |
| 92 | + |
| 93 | +```sh |
| 94 | +npm install |
| 95 | +``` |
| 96 | + |
| 97 | +### Setup .env file |
| 98 | + |
| 99 | +```js |
| 100 | +NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY= |
| 101 | +CLERK_SECRET_KEY= |
| 102 | + |
| 103 | +NEXT_PUBLIC_CLERK_SIGN_IN_URL=/sign-in |
| 104 | +NEXT_PUBLIC_CLERK_SIGN_UP_URL=/sign-up |
| 105 | +NEXT_PUBLIC_CLERK_AFTER_SIGN_IN_URL=/dashboard |
| 106 | +NEXT_PUBLIC_CLERK_AFTER_SIGN_UP_URL=/dashboard |
| 107 | + |
| 108 | +DATABASE_URL= |
| 109 | + |
| 110 | +NEXT_PUBLIC_APP_URL="http://localhost:3000" |
| 111 | +``` |
| 112 | + |
| 113 | +### Setup Prisma |
| 114 | + |
| 115 | +Add MongoDb Database (I am using Mongo Atlas) |
| 116 | + |
| 117 | +```shell |
| 118 | +npx prisma init |
| 119 | +npx prisma generate |
| 120 | +npx prisma db push |
| 121 | +``` |
| 122 | + |
| 123 | +Seed Data: |
| 124 | + |
| 125 | +I am using ChatGPT to generate seed data that will be fed to the database and I would suggest you do the same too. This saves a lot of time in creating test data and you can use this time to work on the UI development. |
| 126 | + |
| 127 | +```shell |
| 128 | +node lib/seed.ts |
| 129 | +``` |
| 130 | + |
| 131 | +### Start the app |
| 132 | + |
| 133 | +```shell |
| 134 | +npm run dev |
| 135 | +``` |
| 136 | + |
| 137 | +<p align="right">(<a href="#readme-top">back to top</a>)</p> |
| 138 | + |
| 139 | +## License |
| 140 | + |
| 141 | +Distributed under the MIT License. See [LICENSE](https://github.com/Kaushik612/reviews.io/blob/main/LICENSE.md) for more information. |
| 142 | + |
| 143 | +## Authors |
| 144 | + |
| 145 | +**Kaushik Ravikumar** - _Full Stack Web Developer_ - [Kaushik Ravikumar](https://github.com/kaushik612) |
| 146 | + |
| 147 | +<!-- MARKDOWN LINKS & IMAGES --> |
| 148 | +<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --> |
| 149 | + |
| 150 | +[contributors-shield]: https://img.shields.io/github/contributors/github_username/repo_name.svg?style=for-the-badge |
| 151 | +[contributors-url]: https://github.com/github_username/repo_name/graphs/contributors |
| 152 | +[forks-shield]: https://img.shields.io/github/forks/github_username/repo_name.svg?style=for-the-badge |
| 153 | +[forks-url]: https://github.com/github_username/repo_name/network/members |
| 154 | +[stars-shield]: https://img.shields.io/github/stars/github_username/repo_name.svg?style=for-the-badge |
| 155 | +[stars-url]: https://github.com/github_username/repo_name/stargazers |
| 156 | +[issues-shield]: https://img.shields.io/github/issues/github_username/repo_name.svg?style=for-the-badge |
| 157 | +[issues-url]: https://github.com/github_username/repo_name/issues |
| 158 | +[license-shield]: https://img.shields.io/github/license/github_username/repo_name.svg?style=for-the-badge |
| 159 | +[license-url]: https://github.com/github_username/repo_name/blob/master/LICENSE.txt |
| 160 | +[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555 |
| 161 | +[linkedin-url]: https://linkedin.com/in/linkedin_username |
| 162 | +[product-screenshot]: images/screenshot.png |
| 163 | +[Next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white |
| 164 | +[Next-url]: https://nextjs.org/ |
| 165 | +[React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB |
| 166 | +[React-url]: https://reactjs.org/ |
| 167 | +[Tailwind.css]: https://img.shields.io/badge/Tailwind_CSS-38B2AC?style=for-the-badge&logo=tailwind-css&logoColor=white |
| 168 | +[Tailwind-url]: https://tailwindcss.com/ |
| 169 | +[Typescript]: https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white |
| 170 | +[Typescript-url]: https:/typescript.org |
| 171 | +[Prisma]: https://img.shields.io/badge/Prisma-3982CE?style=for-the-badge&logo=Prisma&logoColor=white |
| 172 | +[Prisma-url]: https:/prisma.io |
| 173 | +[MongoDB]: https://img.shields.io/badge/MongoDB-4EA94B?style=for-the-badge&logo=mongodb&logoColor=white |
| 174 | +[MongoDB-url]: https:/mongodb.com |
0 commit comments