RoomGPT Documentation

You can deploy RoomGPT with one click using Vercel. Ensure you provide the REPLICATE_API_KEY during the deployment process to ensure the ML model functionality works immediately.

https://vercel.com/new/clone?repository-url=https://github.com/Nutlope/roomGPT&env=REPLICATE_API_KEY&project-name=room-GPT&repo-name=roomGPT

RoomGPT requires a Replicate API key to run the ControlNet ML model.

1. Create an account at Replicate.
2. Navigate to your profile picture in the top left corner and select "API Tokens".
3. Copy your API token.
4. Store this token in your .env file using the key REPLICATE_API_KEY.

To run the RoomGPT application on your local machine, follow these steps:

1. Clone the repository:

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

2. Configure environment variables: Create a .env file in the root directory. You must provide a REPLICATE_API_KEY. If you want to enable rate limiting, you must also provide Upstash Redis credentials (as specified in the .example.env file).
3. Install dependencies:

   npm install

4. Start the development server:

   npm run dev

The application will be available at http://localhost:3000.