FairDeal

Your AI-powered assistant for pricing, analyzing, and publishing marketplace listings.

Live demo: Coming soon — follow instructions below to run it locally today.

FairDeal combines a FastAPI backend with a Next.js frontend to deliver quick insights for buyers and sellers. The platform analyzes listings, surfaces comparable sales, and generates AI-backed pricing recommendations and descriptions.

✨ Highlights

• AI analysis for pricing guidance, safety tips, and description generation
• Buy and sell workflows with multi-step wizard UX and form validation
• Comparable listing aggregation from multiple marketplace sources
• FastAPI REST API with Swagger docs and modular service architecture
• Next.js 15 App Router frontend styled with Tailwind CSS

🧱 Tech Stack

• Frontend: Next.js 15, React 19, Tailwind CSS, TypeScript, React Hook Form, Zod
• Backend: FastAPI, Pydantic, SQLAlchemy, OpenAI API, external marketplace integrations
• Infrastructure (ready for): Render/Railway for backend, Vercel/Netlify for frontend, PostgreSQL for production data

📁 Project Structure

. (repo root)
├── Main.py                 # FastAPI entrypoint
├── routes/                 # API endpoints
├── services/               # AI, pricing, and ingestion logic
├── models/                 # SQLAlchemy models & Pydantic schemas
└── frontend/               # Next.js application (App Router)

Sample uploads live in uploads/ and fixtures in fixtures/ & data/.

⚙️ Environment Setup

1. Duplicate the example environment file and populate credentials:

   copy env.example .env
   # edit .env with actual API keys and secrets

2. (Optional) Create frontend/.env.local with NEXT_PUBLIC_API_URL if your frontend needs to point to a deployed backend.

The backend reads from .env (or system environment variables). See env.example for required keys.

🚀 Run Locally

Backend (FastAPI)

cd MarketPlaceAssistant
python -m venv venv
.\venv\Scripts\Activate.ps1
pip install -r requirements.txt
uvicorn Main:app --reload

API available at http://localhost:8000 with interactive docs at http://localhost:8000/docs.

Frontend (Next.js)

cd MarketPlaceAssistant\frontend
npm install
npm run dev

App available at http://localhost:3000.

✅ Useful Scripts

• npm run dev – Next.js dev server
• npm run build – Production bundle
• npm run start – Run built Next.js app locally
• npm run type-check – TypeScript validation
• .\venv\Scripts\pytest.exe – Backend test entry point (add tests over time)

🧪 Verification Checklist

• Frontend build succeeds: npm run build
• TypeScript passes: npm run type-check
• Backend boots cleanly: uvicorn Main:app --reload
• Optional: initialize ESLint via npx @next/codemod@canary next-lint-to-eslint-cli . and rerun npm run lint

🌐 Deploying

1. Backend – Render/Railway/Fly.io (command uvicorn Main:app --host 0.0.0.0 --port $PORT). Add environment variables from .env and point DATABASE_URL to PostgreSQL for production.
2. Frontend – Vercel/Netlify. Connect this GitHub repo, set NEXT_PUBLIC_API_URL to your backend URL, and use npm run build as the build command.
3. Domain & Demo – Once both services are live, add links (or a short Loom walkthrough) to this README and your résumé.

🗺️ Roadmap Ideas

• Publish hosted demo and add screenshots/GIFs to the README
• Harden authentication/session management with JWTs or OAuth
• Expand comparable listings with additional marketplace APIs
• Add automated tests and continuous integration

📬 Contact / Showcase

• GitHub: https://github.com/Yxniy/MarketPlaceAssistant
• Status: Public portfolio project — live demo coming soon

---

Updated in 2025 to reflect the lean, web-first FairDeal implementation.