Skip to content

Latest commit

 

History

History
291 lines (207 loc) · 10.2 KB

File metadata and controls

291 lines (207 loc) · 10.2 KB

Getting Started — Morning Command Center

Welcome to the 90-minute sprint! This document tells you exactly what's been set up and where to start.


📋 What You Have

Your team has a complete specification package for the Morning Command Center prototype. No ambiguity. No extra meetings. Just spec and build.

Documentation (Read in this order)

  1. README.md — Project overview (1 min)
  2. QUICK_REF.md — One-page sprint guide (2 min)
  3. PROJECT_PLAN.md — 90-minute timeline & task breakdown (3 min)
  4. SETUP.md — Environment setup & dev guide (10 min)
  5. CLAUDE.md — Code standards & team collaboration rules (3 min)

Total reading time: ~20 minutes. Then you code.

Specification Documents

These define what to build. Keep these open while coding.

Architecture & Implementation Guides

These help you build it right.


🚀 Start Here (Pick Your Role)

Product Manager

Read first (5 min):

Then do:

  1. Review specs/FEATURES.md with team
  2. Clarify "overnight" algorithm and priority ranking
  3. Define the 5 recommended actions (see docs/INTEGRATIONS.md — Aggregation Service)
  4. Throughout sprint: Validate metrics accuracy

Key files to keep open:

  • specs/FEATURES.md
  • docs/INTEGRATIONS.md (Aggregation Service section)

Enterprise Architect

Read first (10 min):

Then do:

  1. Review database schema with Full Stack Engineer
  2. Create PostgreSQL schema (users, integration_tokens, overnight_summaries)
  3. Write TypeScript interfaces (src/types/*.ts) — no any types
  4. Create database migration file
  5. Throughout sprint: Review service implementations for data consistency

Key files to keep open:


Full Stack Engineer

Read first (15 min):

Then do:

  1. Set up environment (SETUP.md)
  2. Create mock Jira service (see docs/INTEGRATIONS.md#mock-data-strategy)
  3. Create mock Outlook service (see docs/INTEGRATIONS.md#mock-data-strategy)
  4. Create API routes that use mock services
  5. Implement aggregation logic (with Product Manager's input)
  6. Throughout sprint: Wire frontend → backend via mock APIs

Note: Real API integration is post-sprint work. Use mock data to move fast.

Key files to keep open:

  • specs/API.md
  • specs/DATA_MODEL.md
  • docs/INTEGRATIONS.md

UX Architect

Read first (10 min):

Then do:

  1. Set up Tailwind CSS + theme system
  2. Create component structure (src/components/)
  3. Build OvernightSummaryCard (loading, loaded, error states)
  4. Build KPICard component (all status variants)
  5. Build KPIGrid (responsive: 1 col mobile → 4 col desktop)
  6. Implement theme toggle (light/dark)
  7. Throughout sprint: Ensure responsive design, accessibility

Key files to keep open:


⏰ 90-Minute Timeline

0:00-0:15   Spec Review & Architecture Alignment
0:15-0:45   Data Model & API Contracts
0:45-1:15   Core Components & Services
1:15-1:30   Integration & Demo Prep

See PROJECT_PLAN.md for detailed breakdown.


✅ Checklist Before Starting

Technology & Access

  • Node.js 18+ installed (node --version)
  • PostgreSQL running locally (psql -U postgres)
  • NO real API credentials needed (using mock data)

Repository Setup

  • Git repo cloned
  • .env.local created from .env.example (see SETUP.md)
  • npm install completed
  • Database created (createdb morning_command_center_dev)
  • No TypeScript errors (npm run type-check)

Team Alignment


📁 File Map (What Goes Where)

As you build, follow this structure (defined in SETUP.md):

src/
├── pages/              # Page components (index.tsx, overnight-summary.tsx)
├── components/         # React components (OvernightSummaryCard, KPICard, etc.)
├── api/               # Backend routes (/api/overnight-summary, etc.)
├── services/          # Business logic (jira-service.ts, outlook-service.ts, aggregation-service.ts)
├── hooks/             # Custom hooks (useOvernightSummary, useDashboard)
├── types/             # TypeScript interfaces (jira.ts, outlook.ts, dashboard.ts)
├── styles/            # CSS + Tailwind theme
└── utils/             # Helpers (timezone.ts, attention-score.ts)

🎯 Definition of Done (MVP)

By the end of 90 minutes, you should have:

  • OvernightSummaryCard displays real data from Jira + Outlook
  • Executive Dashboard shows 4+ KPI cards with live metrics
  • Light mode + Dark mode both working
  • Responsive design tested on mobile, tablet, desktop
  • No TypeScript errors (strict mode)
  • No console errors
  • Team understands full data flow (Jira → API → Frontend)

See PROJECT_PLAN.md#success-criteria for full list.


🔗 Key Decisions Already Made

You don't need to debate these:

Decision Rationale
Frontend: React + TypeScript Type safety, component reusability
Styling: Tailwind CSS Enterprise look, consistent theme system
Backend: Node.js + Express (or Next.js) Fast to implement, integrates well with React
Database: PostgreSQL Reliable, JSONB support for extensibility
Auth: OAuth 2.0 Industry standard for Jira + Outlook
Caching: Redis (backend) + localStorage (frontend) Prevents API rate limiting

❓ Frequently Asked Questions

Q: Should we build everything or just MVP?
A: Build MVP in 90 minutes. Use QUICK_REF.md#definition-of-done as your checklist.

Q: What if we get stuck on Jira/Outlook API?
A: Use mock data. Swap real API after sprint. See docs/INTEGRATIONS.md — Testing.

Q: Do we need 100% test coverage?
A: No. Focus on critical paths (aggregation logic, API endpoints). See CLAUDE.md.

Q: How do we handle design decisions?
A: Product Manager or UX Architect decides immediately (< 2 min). No debate. See PROJECT_PLAN.md — Comm & Escalation.

Q: What if we finish early?
A: Stretch goals: PROJECT_PLAN.md#stretch-goals.


🚨 Common Blockers & Solutions

Blocker Solution
Jira API credentials missing Take 5 min to get them (1 person only)
DB connection failing Verify PostgreSQL running, reset connection
Node modules not installing Try npm ci, then npm install
Port 3000 in use Kill process: lsof -ti :3000 | xargs kill -9
TypeScript compilation errors Run npm run type-check to see all at once

See SETUP.md — Troubleshooting for full list.


📞 How to Unblock Quickly

  1. Check the spec — Most questions answered in specs/ or docs/
  2. Ask the team — Use a dedicated Slack/Discord channel
  3. Escalate to role owner — PM/EA/FSE/UX make decisions fast

No async discussions. Decisions must happen in < 2 minutes.


🎬 Ready to Start?

  1. ✅ Everyone has access to this repo
  2. ✅ Everyone read QUICK_REF.md (2 min)
  3. ✅ Everyone checked Prerequisites
  4. ✅ Roles assigned (PM, EA, FSE, UX)
  5. ✅ Timer started (90 min from now)

📚 Documentation Index

Quick Reference

Planning & Process

Specifications (The Source of Truth)

Implementation Guides


Last Updated: July 30, 2025
Status: Ready to sprint
Duration: 90 minutes

Let's build something great! 🚀