RoomGPT - Transform Your Room with AI
RoomGPT is an innovative and open-source tool designed to breathe new life into any space by leveraging the power of artificial intelligence. Initially available as a free version, this tool allows users to experiment with room designs without dealing with subscriptions or intricate features, making it straightforward to clone, deploy, and explore.
How It Works
At the core of RoomGPT is an advanced machine learning model known as ControlNet. This model is geared towards generating diverse room designs. Users can upload a picture of any room, and through a Next.js API route, the image is processed by the ML model to create a new room design. The generated designs are stored via Bytescale, with the ML model hosted on Replicate.
Getting Started Locally
For those interested in testing RoomGPT locally, follow these simple steps:
Clone the Repository
Begin by cloning the project to your local machine using Git:
git clone https://github.com/Nutlope/roomGPT
Acquire an API Key from Replicate
To use the ML model, follow these steps to get an API key:
- Visit Replicate's website and create an account.
- Once registered, click on your profile picture in the top left corner and select "API Tokens."
- Find and copy your API token.
Set Up API Key in .env
Position your API key within a .env file at the project's root. You can use the .example.env file as a guide. For those interested in implementing rate limiting, consider creating an account with UpStash, establish a Redis database, and add the related environment variables into the .env file. If rate limiting is not required, skip this step.
Install Dependencies
Install necessary dependencies by running:
npm install
Run the Application
Execute the following command to start the application:
npm run dev
Your application will be accessible at http://localhost:3000.
One-Click Deploy with Vercel
For an even simpler deployment process, RoomGPT can be effortlessly deployed using Vercel. This one-click deploy feature streamlines the process, making it incredibly user-friendly.
Licensing
RoomGPT is available under the MIT license, encouraging open use and modification.