Quickstart

So you want to run Touch Me locally? This guide will get you there.

Prerequisites

You’ll need git & node.js, and bun is recommended.

Clone & install

git clone git@github.com:oskarrough/touchme.git
cd touchme/web
bun install

Environment setup

Touch Me requires several API keys to function properly. You’ll need access to the Vercel project:

bun run env # runs 'vc env pull' to get env vars from Vercel

Speak to Oskar for actual API keys and Vercel access.

Start the development server

bun dev

This will start the SvelteKit dev server and open the app in your browser.

Project structure

Inside the repository you find three folders:

• /docs - Project documentation (you’re here!)
• /web - The actual game built as a SvelteKit web application
• /content - Backup data

The main branch automatically deploys to https://touchme.0sk.ar/ via Vercel. See deployment.

Disclaimer, most of this was coded alone over a longer period of time without knowing exactly where we were going

Development workflow

# Verify TypeScript types
cd touchme/web
bun run check

# Common issue: Missing API keys
# Fix: Ensure you've run bun run env and have Vercel access

Need help?

You can refer to the references in the sidebar for more detailed information.