Skip to content
Get packs

Guide · Open source

How to use RoomGPT: install, run and redesign a room with AI

Updated · written with AI from the project's own documentation and checked against our catalogue data

RoomGPT is an open-source web app that takes a photo of a room and returns a generated redesign using an AI image model. This guide is for people who want to try it on their own computer or use its code as a starting point for an image-generation project. By the end you will know what accounts and tools you need, how to run the app locally, and what it can and cannot do.

RoomGPTNutlope/roomGPT · ★ 10.7k · MIT

Quick start

  1. 1Clone the repository. Run git clone https://github.com/Nutlope/roomGPT in your terminal.
  2. 2Create a Replicate API token. Sign up at replicate.com, open API Tokens from your profile menu and copy the token.
  3. 3Add the key to .env. Create a .env file in the project root, following .example.env, and store your API key there.
  4. 4Optional: set up rate limiting. If you want it, create an Upstash Redis database and add its two environment variables to .env.
  5. 5Install dependencies. Run npm install in the project folder.
  6. 6Start the app. Run npm run dev and open http://localhost:3000 in your browser.
  7. 7Upload a room photo. Upload an image of a room in the app to generate a redesign.

What RoomGPT does and how it works

You upload a photo of any room. The app sends the image through a ControlNet machine learning model using a Next.js API route, then returns the generated room. ControlNet is the model family that produces the variations.

The model is hosted on Replicate, and Bytescale is used to store images.

What you need before you start

You need Node.js, npm, and a Replicate account with an API token. The README does not specify which Node.js version to use.

If you want rate limiting, you also need an Upstash account with a Redis database. This is optional.

  • Node.js (the README does not give a version)
  • npm
  • A Replicate account and API token
  • Optional: an Upstash Redis database for rate limiting

Get a Replicate API token

Create an account on Replicate, then open your profile picture in the top left corner and choose "API Tokens". Copy the token shown there.

  • Go to replicate.com and create an account.
  • Click your profile picture in the top left corner.
  • Click "API Tokens" and copy your token.

Clone, configure and run RoomGPT locally

Clone the repository, then create a .env file in the project root. Store your API key in it, following the .example.env file included in the project. If you want rate limiting, add the two Upstash environment variables to .env as well. If you skip rate limiting, you make no changes.

Install the dependencies, then start the app. It will be available at http://localhost:3000.

  • Create .env in the root directory and add your Replicate key, as shown in .example.env.
  • Optional: add the two Upstash variables for rate limiting.
git clone https://github.com/Nutlope/roomGPT npm install npm run dev

Deploy RoomGPT with one click

The README includes a Deploy with Vercel button that clones the repository and asks for the REPLICATE_API_KEY environment variable. This is an alternative to running locally.

What people use it for

  • Trying AI room redesign on a photo of your own room
  • Exploring interior layout ideas from a real picture
  • Learning how a Next.js app calls an image model API
  • Using the code as a base for your own image-generation app

Frequently asked questions

Is RoomGPT free?

The repository is MIT licensed, so you can clone, modify and use the code under those terms. The README says the paid RoomGPT.io product is separate and that this open-source version has no auth or payments. Using Replicate to run the model is a separate account, and the README does not describe its pricing.

What do I need to install RoomGPT?

You need Node.js, npm and a Replicate account with an API token. The README does not specify a Node.js version. Upstash is optional and only needed for rate limiting.

How do I run RoomGPT locally?

Run git clone https://github.com/Nutlope/roomGPT, then npm install, then npm run dev. Add your Replicate key to a .env file first, then open http://localhost:3000.

Where do I get the Replicate API key?

Sign in to Replicate, click your profile picture in the top left corner, and choose API Tokens. Copy the token and store it in your .env file.

Does RoomGPT have user accounts or payments?

No. The README says this version is the very first one without auth, payments or additional features. The paid RoomGPT.io SaaS is a separate product.

What are alternatives to RoomGPT?

Comparable projects mentioned for this category are Interior AI and HomeDesigns AI. If you want a hosted service with accounts, RoomGPT's open-source version is not that, so one of these may suit you better.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

RoomGPT is a good fit if you want to try AI room redesign locally, or you are a developer looking for a small Next.js example of calling an image model API. It is not a good fit if you need a ready-made hosted service with accounts, guaranteed output quality, or precise furniture placement, since the README describes none of those.

Install options & downloads