Getting Started

From clone to running in under 2 minutes

01 Prerequisites

Node.js 20+

Runtime environment

npm or yarn

Package manager

Supabase Project

PostgreSQL + Realtime

Clerk Account

Authentication (Email/Google/Microsoft SSO)

Google Cloud Project

Gemini API + Gmail API

Azure App Registration

Microsoft Outlook integration

Optional

02 Installation

Terminal

git clone https://github.com/OfficialPr0x/HostelHack.git
cd HostelHack
npm install

03 Environment Setup

Create a .env.local file in the project root with the following variables:

.env.local

# ─── Authentication (Clerk) ───────────────────────────
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=pk_live_...
CLERK_SECRET_KEY=sk_live_...

# ─── Database (Supabase) ─────────────────────────────
NEXT_PUBLIC_SUPABASE_URL=https://your-project.supabase.co
NEXT_PUBLIC_SUPABASE_ANON_KEY=eyJ...
SUPABASE_SERVICE_ROLE_KEY=eyJ...

# ─── AI (Gemini) ─────────────────────────────────────
GEMINI_API_KEY=AIza...

# ─── Email — Google ──────────────────────────────────
GOOGLE_CLIENT_ID=123456789.apps.googleusercontent.com
GOOGLE_CLIENT_SECRET=GOCSPX-...

# ─── Email — Microsoft ──────────────────────────────
MICROSOFT_CLIENT_ID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
MICROSOFT_CLIENT_SECRET=...
MICROSOFT_TENANT_ID=common

# ─── Background Jobs (Inngest) ──────────────────────
INNGEST_EVENT_KEY=...
INNGEST_SIGNING_KEY=...

# ─── App ─────────────────────────────────────────────
NEXT_PUBLIC_APP_URL=http://localhost:3000

Important: GEMINI_API_KEY must not use the NEXT_PUBLIC_ prefix — it's server-side only to protect the API key.

Provider Configuration

Supabase SetupClick to expand

1. Create a project at supabase.com

2. Go to Settings → API to get your URL and keys

3. Run all migrations from supabase/migrations/

4. Enable Realtime for mail_threads and mail_messages tables

Clerk SetupClick to expand

1. Create an application at clerk.com

2. Enable Email, Google, and Microsoft sign-in methods

3. Copy publishable key and secret key to your .env.local

4. Configure redirect URLs for your domain

Google Cloud (Gmail + Gemini)Click to expand

1. Create a project in Google Cloud Console

2. Enable Gmail API and Generative Language API

3. Create OAuth 2.0 credentials

4. Set redirect URI to https://your-domain/api/inbox/connect/google/callback

5. Request scopes: gmail.modify, gmail.send

6. Get a Gemini API key from Google AI Studio

04 First Run

Terminal

npm run dev

The app starts at http://localhost:3000. Key pages:

/—Landing page

/login—Clerk authentication

/onboarding—Profile setup

/dashboard—NomadOS command center

/search—AI hostel discovery

/inbox—Unified email inbox

/proposals—Proposal management

/hostel—HostelOS portal

Available Commands

npm scripts

npm run dev      # Start dev server (hot-reload)
npm run build    # Production build
npm run start    # Start production server
npm run lint     # ESLint check
npm run clean    # Clear Next.js cache