Quickstart

OpenStays is a normal npm project on top of Convex. There's no separate database to install and no Docker Compose file — npx convex dev provisions a free cloud dev deployment for you and wires up your local .env.local.

1. Clone and install

git clone https://github.com/murdawkmedia/openstays
cd openstays
npm install

2. Start Convex

npx convex dev

The first run walks you through logging in (or creating) a free Convex account, creates a new project, and writes VITE_CONVEX_URL into .env.local for you. Leave this command running in its own terminal — it pushes your schema and functions and keeps them live-reloaded as you edit.

No-account option

If you'd rather not create a Convex account just to poke around locally, run:

CONVEX_AGENT_MODE=anonymous npx convex dev

This spins up an anonymous local dev deployment. It's fine for exploring the codebase; you'll want a real account (still free) once you're ready to deploy somewhere others can reach.

3. Seed the demo inventory

npm run seed

This loads the fictional Pinewood Flats Campground — three lakeview cabins, a glamping yurt, and ten full-hookup RV sites, each with realistic rate plans, seasons, deposit policies, and cancellation windows. It's the only inventory that ships in this repo; everything else is data you load into your own deployment (see Configuration).

The seed is idempotent — running it again is a no-op if Pinewood Flats already exists.

4. Run the app

npm run dev

Open http://localhost:5173.

5. Book a stay at Pinewood Flats

Pick a unit type (try the Lakeview Cabin), choose dates, and go through the guest checkout flow. In local dev there's no live payment provider yet (Stripe/Square land in M1), so the booking flow uses the simulated confirmation path. Once you confirm, open the admin booking tape and watch the reservation appear live — it's the same reactive Convex query, so no refresh is needed.

Next steps

• Configuration — how to describe your own property, units, rate plans, and add-ons as data.
• Self-hosting & deployment — putting a real deployment online for guests to book against.
• Availability & holds — how the booking core keeps two guests from ever taking the same night.