Turn images into LEGO-style 3D models. Upload a photo, and BrickMe converts it to a brickified 3D model you can view and save.

• Node.js 18+ (for the frontend)
• Python 3.10+ (for the backend)
• Redis (must be running locally for image-to-3D job tracking)
• Meshy API key (for 3D conversion; get one at Meshy)

1. Create and activate a virtual environment:

   cd backend
   python -m venv .venv
   source .venv/bin/activate   # On Windows: .venv\Scripts\activate

2. Install dependencies:

   pip install -r ../requirements.txt
   pip install fastapi uvicorn redis pydantic supabase psycopg2-binary

3. Create a .env file in the backend/ directory:

   MESHY_API_KEY=your_meshy_api_key_here
   

   Optional (for Supabase storage and database):

   SUPABASE_URL=https://your-project.supabase.co
   SUPABASE_KEY=your_supabase_anon_key
   DATABASE_URL=postgresql://postgres.[ref]:[password]@aws-0-[region].pooler.supabase.com:6543/postgres
   

4. Start Redis (if not already running):

   redis-server

5. Run the API server:

   python run.py

   The backend will be available at http://localhost:8000

1. Install dependencies:

   cd frontend/brickme
   npm install

2. Create a .env.local file in frontend/brickme/ (optional—defaults work for local dev):

   NEXT_PUBLIC_API_URL=http://localhost:8000
   

   Use this if your backend runs on a different host or port.

3. Start the dev server:

   npm run dev

   Open http://localhost:3000

   Or build and run in production:

   npm run build
   npm run start

   Use npm run start -- -p 4000 to run on port 4000.

Backend .env: Create backend/.env with your keys. Do not commit this file.

Frontend .env.local: Create frontend/brickme/.env.local if you need to point to a different API URL. Do not commit this file.

Without MESHY_API_KEY, the backend falls back to a demo 3D model instead of converting images.

brickme/
├── backend/           # FastAPI API (port 8000)
│   ├── src/
│   │   ├── api/       # API routes
│   │   ├── connections/  # Meshy, Redis, Supabase
│   │   └── three_d/   # Lego pipeline, point cloud
│   ├── data/          # builds.json (local storage)
│   ├── output/        # Generated models
│   └── run.py
├── frontend/brickme/  # Next.js app (port 3000)
│   ├── app/
│   ├── components/
│   └── lib/
└── requirements.txt