Getting Started
Set up your Jose Madrid Salsa development environment
Prerequisites
Before you begin, make sure you have Node.js 20 (see .nvmrc), npm 11, PostgreSQL, and Git installed on your machine.
This is a Turborepo monorepo using npm workspaces. Install from the repository root — npm only honours the root overrides block from there, and a per-app install produces a different dependency tree.
Quick Start
Environment Setup
Follow the Environment Setup Guide to configure your development environment with all required API keys and credentials.
Database Setup
Initialize your PostgreSQL database using the Database Guide. The platform uses Prisma 6. Development runs against Neon; production runs on Supabase — both are plain Postgres reached through Prisma.
Two connection strings are needed: DATABASE_URL (pooled, used at runtime) and DATABASE_URL_UNPOOLED (direct, used by migrations).
npx prisma migrate dev
npx prisma db seedInstall & Run
npm install --legacy-peer-deps
npm run devThe storefront will be available at http://localhost:3000.
Other apps run on their own ports:
| Command | App | URL |
|---|---|---|
npm run dev | storefront | http://localhost:3000 |
npm run dev:fundraising | fundraising | http://localhost:3001 |
npm run dev:docs | documentation | http://localhost:3002 |
npm run dev:admin | admin | http://localhost:3003 |
npm run dev:all | everything, via Turbo | — |
Core Directories
Next Steps
API Documentation
Understand available REST endpoints and authentication
Features
Explore checkout, payments, shipping, and more
Configuration
Environment variables and advanced setup
Authentication Providers
The platform supports Google, GitHub, Facebook, and Apple OAuth in addition to email/password credentials. You'll need to configure OAuth app credentials for each provider you want to enable — see OAuth Configuration.
Minimum to boot
DATABASE_URL, NEXTAUTH_SECRET, NEXTAUTH_URL and MASTER_KEY are required before the app will start. Everything else degrades gracefully when unset. Copy .env.example to .env.local and fill those four first — see Environment Variables.
How is this guide?
Last updated on