Documentation is currently in beta. Report issues →
Getting StartedInstallation

Installation

Follow these steps to set up Y3NKO locally.

Clone the Repository

git clone https://github.com/your-org/yenko-web.git
cd yenko-web

Install Dependencies

npm install

This will install all dependencies and automatically run prisma generate via the postinstall hook.

Database Setup

  1. Create a new project in Supabase Dashboard
  2. Go to Settings > Database and find your connection strings
  3. Copy the connection string (with pooler for DATABASE_URL)
  4. Copy the direct connection string for DIRECT_URL

Using Local PostgreSQL

If you prefer a local database:

# Using Docker
docker run --name y3nko-postgres -e POSTGRES_PASSWORD=postgres -p 5432:5432 -d postgres:15
 
# Connection string
DATABASE_URL="postgresql://postgres:postgres@localhost:5432/y3nko"
DIRECT_URL="postgresql://postgres:postgres@localhost:5432/y3nko"

Run Migrations

npx prisma migrate dev

This creates all database tables based on the Prisma schema.

Seed the Database

npm run db:seed

This populates the database with:

  • Default amenities
  • Sample listings (development only)
  • Test users

Verify Installation

npm run dev

Open http://localhost:3000 in your browser. You should see the Y3NKO homepage.

Project Scripts

ScriptDescription
npm run devStart development server
npm run buildBuild for production
npm run startStart production server
npm run lintRun ESLint
npm run db:generateRegenerate Prisma client
npm run db:migrateRun database migrations
npm run db:pushPush schema changes (no migration)
npm run db:seedSeed the database
npm run db:studioOpen Prisma Studio
npm run db:resetReset database (destructive)

Prisma Studio (npm run db:studio) opens a visual database browser at http://localhost:5555.