Skip to content

QUICKSTART.md

Latest commit

 

History

History
85 lines (61 loc) · 1.71 KB

QUICKSTART.md

File metadata and controls

85 lines (61 loc) · 1.71 KB

🚀 Quick Start Guide

Get Quota Quest running in 3 minutes!

Step 1: Get Your API Key

  1. Go to https://platform.openai.com/api-keys
  2. Sign up or log in
  3. Create an API key
  4. Copy the key (starts with sk-...)

Step 2: Set Up Environment

# Navigate to the project
cd quota-quest

# Copy environment template
cp server/.env.example server/.env

# Edit the .env file and paste your API key
nano server/.env
# or
open server/.env

Your .env file should look like:

OPENAI_API_KEY=sk-your-actual-key-here
PORT=3000

Step 3: Run the Game

Option A: Easy Start (Recommended)

./start-game.sh

This will:

  • Install dependencies automatically
  • Start the server
  • Open the game in your browser

Option B: Manual Start

# Install dependencies
cd server
npm install

# Start server
npm start

# In another terminal, serve the frontend
cd ..
python3 -m http.server 8000

# Open http://localhost:8000 in your browser

That's It!

You should see the retro green terminal-style game. Click [START GAME] and begin your journey to Austin! 🎮

Troubleshooting

"Error connecting to grading server"

  • Make sure the server is running (you should see "🚀 Quota Quest server running")
  • Check that port 3000 isn't being used by another app

"Invalid API key"

  • Verify your API key is correctly pasted in server/.env
  • Make sure there are no extra spaces or quotes
  • The key should start with sk-

Game doesn't load

  • Check browser console (F12) for errors
  • Try a different browser (Chrome, Firefox, Safari)
  • Make sure you're accessing through localhost, not file://

Need more help? Check the full README.md