Log inSign up
panphora
panphorahyperclay-test-app
Remix of panphora/hyperclay
Public
Like
hyperclay-test-app
Val Town is a collaborative website to build and scale JavaScript apps.
Deploy APIs, crons, & store data – all from the browser, and deployed in milliseconds.
Sign up now
Code
/
SETUP.md
Search
9/4/2025
SETUP.md

Quick Setup Guide

1. Set Environment Variables

In your Val.town environment, set:

  • ADMIN_EMAIL - Your email address (required)
  • APP_NAMESPACE - Optional namespace for multiple deployments (defaults to "default")

2. Deploy

The index.ts file is already configured as an HTTP trigger. Just save and it's live!

3. Test the Flow

  1. Visit your Val.town URL - You should see the Hyperclay starter template
  2. Visit /auth/edit - Enter your admin email
  3. Check your email - Click the magic link
  4. Return to main page - You should now see edit controls

4. Start Editing

Once authenticated:

  • Content with edit-mode-contenteditable becomes editable
  • Elements with edit-mode-show become visible
  • Auto-save works with Ctrl+S
  • Visit /versions to see change history

5. Share Your App

  • Public users see read-only version
  • Only you (admin email) can edit
  • Changes are immediately visible to all users

That's it! You now have a fully functional Hyperclay-compatible self-updating page.

Next Steps

  • Customize the DEFAULT_HTML template
  • Add your own content with Hyperclay attributes
  • Share your public URL with others
  • Use /auth/view to switch back to read-only mode
Get started with a template: