Skip to content

skylynxf1/homebase

Repository files navigation

RoomPortal AI

Turn floor plans and room photos into browser-based 3D home walkthroughs with a conversational assistant. Hackathon MVP built on Next.js 16.

Quick start

npm install
npm run dev

Open http://localhost:3000. Try the prebuilt demo at /walkthrough/demo, upload your own files at /upload, or use the Sketch → 3D STL feature at /sketch-3d.

For the Sketch → 3D feature, also install Python dependencies and run FastAPI:

python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
npm run dev:full

For free local AI generation, install TripoSR:

npm run setup:triposr

User journey

  1. Upload — Floor plan (required) + up to 5 room photos at /upload.
  2. Process — RocketRide pipeline runs server-side (Sharp heuristics, not external ML).
  3. Walk — Redirect to /walkthrough/{sessionId} for 3D view, room navigator, and Photon-style chat.
  4. Sketch add-on — Draw or prompt at /sketch-3d, preview with Three.js, and download STL.

Tech stack

Layer Technology
Framework Next.js 16 (App Router), React 19
3D Three.js, React Three Fiber, drei
Images Sharp (server-side pipeline)
UI Tailwind CSS 4, Framer Motion, Lucide
State Zustand (lib/store.ts, lightly used)
Sketch STL add-on Fabric.js, FastAPI, TripoSR, Pillow, NumPy, Trimesh

Documentation

All guides live in docs/. See docs/README.md for the full index.

Document Audience Contents
docs/ARCHITECTURE.md Humans & agents Layers, directory tree, branding vs reality, pitfalls
docs/DATA-FLOW.md Humans & agents Upload → pipeline → walkthrough sequences
docs/API.md Integrators & agents All HTTP routes, schemas, curl examples
docs/PIPELINE.md Pipeline work RocketRide nodes, heuristics, error paths
docs/SCENE-MODEL.md 3D & data work HomeScene schema, coordinates, demo fallback
docs/COMPONENTS.md Frontend work React components and page wiring
docs/DEVELOPMENT.md Contributors Setup, env vars, where to change what
docs/SKETCH-3D.md Feature work Sketch canvas, FastAPI, Meshy, STL flow
AGENTS.md Coding agents Read order, file index, task routing, assumptions

Project layout (source)

docs/                # Project documentation (architecture, API, pipeline, etc.)
app/                 # Pages and API routes
backend/             # FastAPI Sketch → 3D generation service
components/          # Upload, 3D, navigator, chat UI
lib/                 # Pipeline orchestrator, scene types, Photon helpers
pipelines/nodes/     # Image processing steps
public/uploads/      # Per-session uploads and scene.json (runtime)

Environment

Variable Required Purpose
NEXT_PUBLIC_APP_URL No Share links in Photon API and pipeline logs (defaults to http://localhost:3000)
FASTAPI_BASE_URL No Next proxy target for Sketch → 3D (defaults to http://127.0.0.1:8000)
TRIPOSR_DIR No Enables free local TripoSR image-to-3D generation
TRIPOSR_PYTHON No Python binary for TripoSR dependencies

Deploy

Vercel-friendly. Set NEXT_PUBLIC_APP_URL to your production origin. Uploads persist under public/uploads/ on the server filesystem (no database).

Important notes

  • RocketRide and Photon are product names for local orchestration and rule-based chat — not external SDKs in this repo.
  • @xenova/transformers is listed in dependencies but not used in application code.
  • Pipeline progress is stored in memory and is lost on server restart.

See docs/ARCHITECTURE.md for full system design.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors