Documentation is currently in beta. Report issues →
Getting StartedPrerequisites

Prerequisites

Before setting up Y3NKO locally, ensure you have the following tools and accounts.

Required Software

SoftwareMinimum VersionPurpose
Node.js18.17+JavaScript runtime
npm9.0+Package manager
Git2.30+Version control
SoftwarePurpose
DockerLocal PostgreSQL (alternative to Supabase)
VS CodeRecommended IDE with extensions

Required Accounts

You’ll need accounts on the following services:

Supabase (Database & Auth)

  • Sign up at supabase.com
  • Create a new project
  • Note your project URL and anon key
  • You’ll get a PostgreSQL connection string

Paystack (Payments)

  • Sign up at paystack.com
  • Complete business verification (required for production)
  • Get your test API keys from the dashboard
  • Supports Mobile Money and card payments

Cloudinary (Images)

  • Sign up at cloudinary.com
  • Create an upload preset for unsigned uploads
  • Note your cloud name, API key, and API secret

Resend (Emails)

  • Sign up at resend.com
  • Verify your domain (or use their test domain)
  • Get your API key

Google OAuth (Optional)

  • Go to Google Cloud Console
  • Create a new project
  • Enable Google+ API
  • Create OAuth 2.0 credentials
  • Add authorized redirect URIs

VS Code Extensions

Recommended extensions for development:

{
  "recommendations": [
    "dbaeumer.vscode-eslint",
    "esbenp.prettier-vscode",
    "prisma.prisma",
    "bradlc.vscode-tailwindcss",
    "formulahendry.auto-rename-tag",
    "dsznajder.es7-react-js-snippets"
  ]
}

System Requirements

  • RAM: 8GB minimum, 16GB recommended
  • Storage: 1GB free space for project and dependencies
  • OS: macOS, Windows (with WSL2), or Linux
⚠️

If you’re on Windows, we recommend using WSL2 (Windows Subsystem for Linux) for the best development experience.