Just Ship It

An AI-powered search engine that generates real estate market reports.

---

🗂️ Overview

• Setup Instructions
• Deploy
• Tech Stack

---

🚀 Setup Instructions

Follow these steps to set up the application for local development and deployment.

1. Prerequisites

Install Redis

Make sure you have a local Redis instance installed and running:

• On macOS:

  brew install redis
  brew services start redis

• On Ubuntu/Debian:

  sudo apt update
  sudo apt install redis
  sudo systemctl start redis

• On Windows: Use the Redis MSI installer or run it in a Docker container.
• Verify local Redis installation

  redis-cli ping

  You should see PONG returned.

Note: The local Redis instance is ephemeral, meaning its data will be cleared when the instance stops.

Get API Keys

• OpenAI API Key: Obtain your key from OpenAI.
• Tavily API Key: Get your key from Tavily.

2. Fork and Clone the Repository

Fork the repo to your GitHub account, then clone it locally:

git clone https://github.com/hoppybunny/just-ship-it.git

3. Install Dependencies

Use pnpm to install dependencies:

pnpm install

4. Configure Environment Variables

Create a local .env file:

Update the .env.local file with your API keys and local Redis URL:

OPENAI_API_KEY=<your_openai_api_key>
TAVILY_API_KEY=<your_tavily_api_key>
USE_LOCAL_REDIS=true
LOCAL_REDIS_URL=redis://localhost:6379

5. Run the Application Locally

Start the development server:

pnpm dev

Visit http://localhost:3000 to access the app.

---

🌐 Deploy

Deploy your live version of the application using Vercel.

---

🧱 Tech Stack

Core Framework

• Next.js: App Router, React Server Components.
• TypeScript: Type safety.
• Vercel AI SDK: Text streaming and Generative UI.

AI & Search

• OpenAI: Default AI provider.
• Tavily AI: Default search provider.

Data Storage

• Redis: Local Redis option.

UI & Styling

• Tailwind CSS: Utility-first CSS framework.
• shadcn/ui: Reusable components.
• Radix UI: Accessible, unstyled components.
• Lucide Icons: Consistent and beautiful icons.

---