README.md

🍞 Breaddit - Reddit clone

View example

Build with

• Next.js
• React Hook Form
• React Query
• Tailwind CSS
• Radix UI
• Zod
• TypeScript
• Editorjs
• NextAuth.js
• Prisma

Deployed with

• Vercel
• Upstash
• PlanetScale
• Uploadthing
• Sentry

Getting Started

Setup project locally for development.

Setup

• npm

  npm install npm@latest -g

• Create .env.local file at the root level of the project and copy env variables from .env.example file.

Installation

1. Fork the repo
2. Clone the repo

   git clone https://github.com/[YOUR_USERNAME]/[YOUR_FORKED_PROJECT_NAME].git

3. Install the dependencies

   yarn

4. Start the development server

   yarn dev

5. Your project will be running at http://localhost:3000

(back to top)

Runnig database migrations

yarn prisma db push

Generating Prisma Client

yarn prisma generate

Utils

How to implement Google Authentication in a Next.js app using NextAuth

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn and create. Any contribution you make will be highly appreciated.

Feel free to fork the repository or create a pull request. And don't forget to give the project a star! 😉

1. Fork the repository
2. Create your feature branch (git checkout -b feature/new-feature)
3. Commit your changes (git commit -m 'Add some new feature')
4. Push to the branch (git push origin feature/new-feature)
5. Open a Pull Request

(back to top)