Skip to content

LOCAL_DEVELOPMENT.md

Latest commit

 

History

History
59 lines (43 loc) · 1.35 KB

LOCAL_DEVELOPMENT.md

File metadata and controls

59 lines (43 loc) · 1.35 KB

Local Development

Prerequisites

  • Node.js 20.x
  • Docker and Docker Compose (for local PostgreSQL)
  • An S3-compatible storage bucket (AWS S3, Cloudflare R2, Railway Object Storage, or similar)

Full Setup

# 1. Clone the repository
git clone <your-brainstack-repo-url>
cd <your-brainstack-app-directory>

# 2. Install dependencies
npm install

# 3. Configure environment variables
cp .env.example .env
# Edit .env - fill in DATABASE_URL, AUTH_SECRET, PAYLOAD_SECRET, and S3 credentials

# 4. Start the local PostgreSQL instance
docker compose up -d postgres

# 5. Apply database migrations
npm run db:migrate:deploy

# 6. (Optional) Seed an admin account and sample content
npm run cms:seed

# 7. Start the development server
npm run dev

Quick Local Start

npm install
cp .env.example .env
# Fill required env values
npm run dev

If you run with Docker, use:

docker compose --env-file .env up --build

Local URLs

URL Purpose
http://localhost:3000 Student-facing application (landing)
http://localhost:3000/login Sign in
http://localhost:3000/dashboard Signed-in learner home (courses in progress, practice, flashcards)
http://localhost:3000/courses Full published course catalog (filters, search, sort, pagination)
http://localhost:3000/admin Payload CMS admin panel