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)

Searching Database…

10.7K ·GitHub
这是什么?RoomGPT 允许你上传任意房间的照片,并利用机器学习模型生成一张由 AI 重新设计的效果图。
这是 Web 应用还是代码库?这是一个 Next.js Web 应用,你可以在本地运行或部署它,而不是可以导入到其他项目中的库。
我该如何在本地运行它?克隆仓库,按照 .example.env 的说明创建 .env 文件并填入你的 Replicate API 密钥,然后安装依赖,并运行 Next.js 开发服务器。
使用它需要 Replicate API 密钥吗?需要。运行 ControlNet 模型必须提供 Replicate API 令牌;图片存储使用 Bytescale;只有在你需要速率限制时才需要 UpStash Redis。
这和付费版的 RoomGPT.io 是同一个产品吗?不是。本仓库是 RoomGPT.io 的原始开源版本,不包含身份验证、支付功能,也没有付费 SaaS 中的其他额外功能。
RoomGPT 使用什么 AI 模型来重新设计房间?它使用 ControlNet 生成房间效果图,这是一个托管在 Replicate 上的机器学习模型,会根据你上传的照片生成多种变体。
我上传的房间照片会存放在哪里?上传的图片会先使用 Bytescale 存储,然后再发送到 Replicate 上的 ControlNet 模型进行处理。
我能轻松部署自己的副本吗?可以。README 中除了手动本地安装说明外,还提供了一键部署到 Vercel 的选项。
Creator
Nutlope
Size
22.2 MB
Stars
10.7K
Updated
CommitSep 20
Age
3y
Commits · 90 Days