Skip to content

Latest commit

 

History

History
74 lines (50 loc) · 2.14 KB

README.md

File metadata and controls

74 lines (50 loc) · 2.14 KB
Raw

Birddit - A Reddit Clone

Built with the Next.js App Router, TypeScript, Tailwind, Zod, NextAuth.

Features

  • Infinite scrolling for dynamically loading posts using React-Query.
  • Authentication using Google OAuth.
  • Custom feed for authenticated users based on their subscriptions.
  • Advanced caching using Upstash Redis for the most popular posts.
  • Optimistic updates for a great user experience for post and comment voting using React-Query.
  • Modern data fetching using React-Query.
  • A beautiful and highly functional post editor.
  • Image uploads & link previews using UploadThing.
  • Full comment functionality with nested replies.
  • Prisma ORM for a type-safe database layer.
  • Zod for type-safe validation.

Getting started

Prerequisites

  • Node.js 18.17 or later.
  • pnpm or another package manager.
  • A database compatible with Prisma (PostgreSQL, MySQL, SQLite, SQL Server, or a cloud database).
  • An Upstash Redis instance for caching.
  • A Google OAuth client ID and secret.
  • An UploadThing app ID and secret.

Installation

Step 1: Git Clone

In your terminal, run the following command.

git clone git@github.com:dragos-cojocaru/birddit.git

Step 2: Place yourself at the root of the project

cd birddit

Step 3: Setup environment variables

Birddit requires you to set some environment variables. Locally, you should set them through a .env file.

To do so, make a copy of the .env.example file and rename it to .env:

cp .env.example .env

Then, open the .env file and fill in the required values for the database, JWT secret, Google OAuth, UploadThing, and Upstash Redis.

Step 4: Install dependencies

pnpm install

Step 5: Run the development server

pnpm dev

Birddit should now be running on http://localhost:3000.

Acknowledgements