roomGPT README

The project's README from github.com/Nutlope/roomGPT. As one markdown file: README.md.

RoomGPT - redesign your room with AI

This is the previous and open source version of RoomGPT.io (a paid SaaS product). It's the very first version of roomGPT without the auth, payments, or additional features and it's simple to clone, deploy, and play around with.

Deploy with Vercel

Room GPT

How it works

It uses an ML model called ControlNet to generate variations of rooms. This application gives you the ability to upload a photo of any room, which will send it through this ML Model using a Next.js API route, and return your generated room. The ML Model is hosted on Replicate and Bytescale is used for image storage.

Running Locally

Cloning the repository the local machine.

git clone https://github.com/Nutlope/roomGPT

Creating a account on Replicate to get an API key.

  1. Go to Replicate to make an account.
  2. Click on your profile picture in the top left corner, and click on "API Tokens".
  3. Here you can find your API token. Copy it.

Storing the API keys in .env

Create a file in root directory of project with env. And store your API key in it, as shown in the .example.env file.

If you'd also like to do rate limiting, create an account on UpStash, create a Redis database, and populate the two environment variables in .env as well. If you don't want to do rate limiting, you don't need to make any changes.

Installing the dependencies.

npm install

Running the application.

Then, run the application in the command line and it will be available at http://localhost:3000.

npm run dev

One-Click Deploy

Deploy the example using Vercel:

Deploy with Vercel

License

This repo is MIT licensed.

roomGPT (Nutlope/roomGPT)

rate-limiting
Searching Database…

10.7K ·GitHub
RoomGPT
What is this?RoomGPT lets you upload a photo of any room and generates an AI-redesigned version of it using a machine learning model.
Is this a web app or a library?It's a Next.js web application you run locally or deploy, not a library you import into another project.
How do I get it running locally?Clone the repo, create a .env file with your Replicate API key (following .example.env), install the dependencies, and run the Next.js dev server.
Do I need a Replicate API key to use this?Yes, a Replicate API token is required to run the ControlNet model; Bytescale is used for image storage, and UpStash Redis is only needed if you want rate limiting.
Is this the same as the paid RoomGPT.io product?No, this repo is the original open-source version of RoomGPT.io without authentication, payments, or the extra features found in the paid SaaS.
What AI model does roomGPT use to redesign rooms?It uses ControlNet, an ML model hosted on Replicate, to generate room variations from your uploaded photo.
Where do my uploaded room photos go?Uploaded images are stored using Bytescale before being sent to the ControlNet model on Replicate for processing.
Can I deploy my own copy easily?Yes, the README includes a one-click Deploy to Vercel option alongside manual local setup instructions.
What are similar projects?open-higgsfield, printfilm, krita-ai-diffusion, artcraft-services, stable-diffusion-webui, Open-Generative-AI, waoowaoo, sd-webui-controlnet
Which topics is it in?upstash, controlnet, ai-art, rate-limiting, diffusion, saas, app, redis, image-generation, image-processing, nextjs, generative-ai
Creator
Nutlope
Size
22.2 MB
Stars
10.7K
Updated
CommitSep 20
Age
3y
Commits · 90 Days