Documentation is currently in beta. Report issues →
Getting StartedFirst Run

First Run

After completing installation and environment setup, here’s how to explore Y3NKO.

Start the Development Server

npm run dev

The application will be available at http://localhost:3000.

Explore the Application

Public Pages

URLDescription
/Homepage with featured listings
/accommodationsBrowse all accommodations
/accommodations/[slug]Individual listing detail
/activitiesBrowse activities (view only)
/destinationsExplore destinations
/aboutAbout Y3NKO

Authentication

URLDescription
/loginSign in page
/registerCreate account

User Dashboard (Requires Auth)

URLDescription
/dashboardUser dashboard overview
/dashboard/bookingsView your bookings
/dashboard/favoritesSaved listings
/dashboard/profileProfile settings

Host Dashboard (Requires Host Role)

URLDescription
/hostHost dashboard overview
/host/listingsManage your listings
/host/listings/newCreate a new listing
/host/bookingsView bookings for your listings

Admin Dashboard (Requires Admin Role)

URLDescription
/adminAdmin dashboard overview
/admin/listingsManage all listings
/admin/bookingsManage all bookings
/admin/usersManage users

Test Accounts

If you ran the seed script, these test accounts are available:

EmailPasswordRole
user@test.compassword123User
host@test.compassword123Host
admin@test.compassword123Admin
⚠️

Test accounts are only created in development. Never use these in production.

Database Explorer

Open Prisma Studio to browse your database:

npm run db:studio

This opens a visual database browser at http://localhost:5555.

Making Your First Booking

  1. Browse to /accommodations
  2. Click on a listing to view details
  3. Select dates and number of guests
  4. Click “Book Now”
  5. Sign in or create an account
  6. Enter guest details
  7. Proceed to payment (use Paystack test credentials)

Paystack Test Credentials

For testing payments in development:

Test Card:

  • Number: 4084 0840 8408 4081
  • CVV: 408
  • Expiry: Any future date
  • PIN: 0000
  • OTP: 123456

Test Mobile Money (MTN):

  • Phone: 0551234987
  • OTP: 123456

Next Steps

Troubleshooting

Common Issues

Database connection failed:

  • Verify DATABASE_URL and DIRECT_URL are correct
  • Check if Supabase project is active
  • Ensure IP is not blocked by Supabase

Authentication not working:

  • Verify Supabase URL and keys
  • Check redirect URLs match your NEXT_PUBLIC_APP_URL

Payments failing:

  • Ensure you’re using test keys in development
  • Check Paystack dashboard for webhook logs

See Troubleshooting for more solutions.

Environment SetupOverview