Quick Start Guide

Step 1: Install the Hallway CLI

Install the Hallway command-line interface using Deno:

deno install -grAf jsr:@hallway/hw

Step 2: Get Your API Key

Sign in to Hallway and get your API key from the settings page.

hw setup

Step 3: Create a New App

Create a new Hallway app using the CLI:

hw create my-first-app

This will create a new directory with a basic Hallway app structure.

Step 4: Write Your App

Open main.tsx and add your app code:

// main.tsx
export default function App() {
  return (
    <div className="p-8">
      <h1 className="text-3xl font-bold mb-4">Hello, Hallway!</h1>
      <p className="text-gray-600">Welcome to your first app.</p>
      <button
        className="mt-4 px-4 py-2 bg-blue-500 text-white rounded"
        onClick={() => alert('Hello from Hallway!')}
      >
        Click me!
      </button>
    </div>
  );
}

Step 5: Push to Hallway

Push your app to Hallway to make it available online:

cd my-first-app
hw push

Your app will be deployed and accessible through your Hallway space!

Step 6: Watch for Changes

During development, use watch mode to automatically sync changes:

hw watch

Any changes you make will be automatically pushed to Hallway!