Jose Madrid Salsa Documentation
Complete documentation for the Jose Madrid Salsa e-commerce platform
Welcome to the Jose Madrid Salsa Developer Docs
Everything you need to understand, build upon, and deploy the Jose Madrid Salsa e-commerce platform. Start with Getting Started or jump straight to the section you need.
Repository
jordolang/josemadridsalsa
Quick Navigation
Getting Started
Set up your dev environment and run the project locally
API Reference
REST API endpoints, authentication, and request schemas
Features
Storefront, checkout, fundraising, back office, and more
Guides
Task-oriented walkthroughs for operators and developers
Integrations
Stripe, PayPal, Square, Google Maps, and email services
Deployment
Deploy to Vercel, manage environments, and CI/CD
Configuration
Environment variables, database, and service setup
Platform Overview
Jose Madrid Salsa is a full-featured e-commerce platform built with Next.js 16, Prisma, and TypeScript.
- E-commerce — Product catalog, shopping cart, checkout, and order management
- Payment Processing — Stripe, PayPal, Square, and an in-person POS register
- Shipping & Fulfillment — EasyPost rates, label generation, tracking
- Fundraising — Campaigns, participants, commission, and the gamified battle arena
- Admin Dashboard — Orders, products, customers, staff, and role-based access
- Financials — A bookkeeping ledger synced into QuickBooks Online
- Email Marketing — Automated campaigns, templates, and engagement tracking
- Social Commerce — Scheduled posts and marketplace product listings
- Framework: Next.js 16 (App Router, Server Components)
- Monorepo: Turborepo with npm workspaces, Node 20
- Database: PostgreSQL via Prisma 6 — Neon in development, Supabase in production
- Auth: NextAuth.js with Google, GitHub, Facebook, Apple OAuth
- Styling: Tailwind CSS 4 with Shadcn UI / Radix primitives
- Deployment: Vercel — one project per app, all from this repository
- Monitoring: Sentry error tracking, Vercel Analytics
- Payments: Stripe, PayPal, Square
- Email: Nodemailer, Resend, React Email templates
- Maps: Google Maps Platform (Places, Geocoding)
- Storage: Vercel Blob, UploadThing
- Analytics: Google Analytics, Amplitude (with session replay), Vercel Analytics
- AI: Anthropic Claude API — the Picante chat assistant and RAG
- Accounting: QuickBooks Online (the source of truth for the books)
Project Structure
Essentially all product code lives in apps/storefront — the storefront, the admin
console, the fundraiser portal, the register and every API route. There is no
apps/backend. See Monorepo Deployment.
Getting Started
Clone the Repository
git clone https://github.com/jordolang/josemadridsalsa.git
cd josemadridsalsaInstall Dependencies
From the repository root — npm only honours the root overrides block from there:
npm install --legacy-peer-depsConfigure Environment
Copy the example environment file and add your credentials:
cp .env.example .env.localSee the Configuration Guide for all required variables.
Database Required
You'll need a PostgreSQL database to run the project. Development uses Neon; production runs on Supabase. Both need two connection strings — DATABASE_URL (pooled, runtime) and DATABASE_URL_UNPOOLED (direct, migrations). See the Database Setup guide.
Documentation Map
Explore how every section of the docs connects. Click a node to jump to that page.
Getting Help
How is this guide?