Skip to content

Latest commit

 

History

History
66 lines (47 loc) · 1.43 KB

README.md

File metadata and controls

66 lines (47 loc) · 1.43 KB

Plura API

The backend API service for Plura, built with Next.js, Hono, Prisma and Upstash.

Check list

Before setting up the API, ensure you have:

  • Node.js >= 18
  • PNPM package manager below 19 not supported
  • PostgreSQL database
  • Redis instance (Upstash)

Setup

  1. Install dependencies:
pnpm install
  1. Create a .env file in the apps/api directory with the following variables:
# Required: Your Resend API key for email services
RESEND_API=

# Required: Base URL of your application
BASE_URL=

# Required: Authentication configuration
BETTER_AUTH_SECRET=
BETTER_AUTH_URL=

# Optional: OAuth provider credentials
# For Google OAuth (https://console.cloud.google.com)
GOOGLE_CLIENT_ID=
GOOGLE_CLIENT_SECRET=

# For Discord OAuth (https://discord.com/developers)
DISCORD_CLIENT_ID=
DISCORD_CLIENT_SECRET=

# For GitHub OAuth (https://github.com/settings/developers)
GITHUB_CLIENT_ID=
GITHUB_CLIENT_SECRET=
   
# Required: PostgreSQL connection string
DATABASE_URL=

#Required: Upstash Redis configuration (https://upstash.com)
UPSTASH_REDIS_REST_TOKEN=
UPSTASH_REDIS_REST_URL=

📞 Contact

Contributing

Engineered with ❤️ by the Plura Team