Instructions to get the project up and running
First, install the necesarry dependencies. We use bun as our package manager
# Using bun (recommended)
bun install
# Or with yarn
yarn install
# Or with npm
npm installCreate a .env.local file in the project root / and add the following variables (replace values as needed):
# Database (Get it From Neon DB -> Create an account and a project)
DATABASE_URL=postgresql://user:password@host:5432/dbname
# Supabase
NEXT_PUBLIC_SUPABASE_URL=your-supabase-url
NEXT_PUBLIC_SUPABASE_PUBLISHABLE_DEFAULT_KEY=your-supabase-anon-key
# Stripe
STRIPE_SECRET_KEY=your-stripe-secret-key
# Bunny Stream
BUNNY_STREAM_API_KEY=your-bunny-api-key
# Redis (Upstash)
UPSTASH_REDIS_REST_URL=your-upstash-redis-url
UPSTASH_REDIS_REST_TOKEN=your-upstash-redis-token
# UploadThing (For Images)
UPLOADTHING_TOKEN=api_key_for_ut
#CLERK
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=clerk_test_key
CLERK_SECRET_KEY=clerk_secret_test_key
NEXT_PUBLIC_CLERK_SIGN_IN_URL=/sign-in
NEXT_PUBLIC_CLERK_SIGN_UP_URL=/sign-up
NEXT_PUBLIC_CLERK_SIGN_IN_FALLBACK_REDIRECT_URL=/
NEXT_PUBLIC_CLERK_SIGN_UP_FALLBACK_REDIRECT_URL=/
CLERK_SIGNING_SECRET=secret_for_webhooks
#OpenAi key for the embeddings search
OPENAI_API_KEY=
Tip: Not all features require every variable, but missing values may disable related integrations.
# Using bun (recommended)
bun run dev
# Or with npm/yarn/pnpm
npm run dev
yarn dev
pnpm devOpen http://localhost:3000 to view the app.
Most of the components logic is under /modules to take advantage of tRPC prefetching and caching.
(...) are usually server components where we prefetch data. You'll usually see the void trpc. ... .prefetch() here.
This project uses next/font to automatically optimize and load Geist, a new font family for Vercel.
To learn more about Next.js, take a look at the following resources:
- Next.js Documentation - learn about Next.js features and API.
- Learn Next.js - an interactive Next.js tutorial.
You can check out the Next.js GitHub repository - your feedback and contributions are welcome!
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.