203 lines
6.3 KiB
Markdown
203 lines
6.3 KiB
Markdown
# Instructions for Job-Info-Prod Scaffolding
|
|
|
|
## 📂 What's In This Folder
|
|
|
|
This folder contains **all documentation and specifications** for scaffolding and building the production-ready Job-Info-Prod application.
|
|
|
|
---
|
|
|
|
## 🎯 Primary Documents
|
|
|
|
### For Claude Opus 4.5 (Scaffolding Phase)
|
|
|
|
**Start Here:**
|
|
1. **[OPUS_PROMPT_PHASE1.md](OPUS_PROMPT_PHASE1.md)** (671 lines)
|
|
- Complete architecture specification
|
|
- Dual-token system design
|
|
- Project structure
|
|
- Code examples
|
|
- **→ Send this entire file to Opus 4.5**
|
|
|
|
2. **[OPUS_QUICKSTART.md](OPUS_QUICKSTART.md)** (400 lines)
|
|
- Step-by-step instructions for using Opus
|
|
- Exact prompt to give Opus
|
|
- What to expect
|
|
- What to do after scaffolding
|
|
|
|
### For Claude Sonnet 4.5 (Implementation Phase)
|
|
|
|
**Use These:**
|
|
1. **[auth/RULES.md](auth/RULES.md)** - Implementation rules (dual-token system)
|
|
2. **[auth/TECH_STACK.md](auth/TECH_STACK.md)** - Technology enforcement
|
|
3. **[auth/FLOWMAP.md](auth/FLOWMAP.md)** - Architecture diagrams
|
|
4. **[auth/VIEWS.md](auth/VIEWS.md)** - UI specifications
|
|
|
|
---
|
|
|
|
## 📚 Supporting Documentation
|
|
|
|
### Project Planning
|
|
- **[MIGRATION_READY.md](MIGRATION_READY.md)** - Complete 4-phase migration plan
|
|
- **[PRODUCTION_MIGRATION_PLAN.md](PRODUCTION_MIGRATION_PLAN.md)** - Detailed implementation roadmap
|
|
- **[PROJECT_STATUS.md](PROJECT_STATUS.md)** - Complete project overview
|
|
|
|
### Architecture & Status
|
|
- **[ARCHITECTURE_CONFIRMED.md](ARCHITECTURE_CONFIRMED.md)** - Architecture verification
|
|
- **[DOCUMENTATION_COMPLETE.md](DOCUMENTATION_COMPLETE.md)** - Documentation completion summary
|
|
- **[DOCUMENTATION_OVERVIEW.md](DOCUMENTATION_OVERVIEW.md)** - Full documentation overview
|
|
- **[FINAL_CHECKLIST.md](FINAL_CHECKLIST.md)** - Launch readiness checklist
|
|
|
|
### Developer Onboarding (auth/ folder)
|
|
- **[auth/README.md](auth/README.md)** - Documentation overview
|
|
- **[auth/INDEX.md](auth/INDEX.md)** - Navigation guide
|
|
- **[auth/ONBOARDING.md](auth/ONBOARDING.md)** - Getting started guide
|
|
- **[auth/DOCUMENTATION_SUMMARY.md](auth/DOCUMENTATION_SUMMARY.md)** - What was created
|
|
|
|
---
|
|
|
|
## 🚀 Quick Start
|
|
|
|
### Step 1: Read the Opus Prompt
|
|
```bash
|
|
# Open the main prompt
|
|
cat OPUS_PROMPT_PHASE1.md
|
|
```
|
|
|
|
### Step 2: Review Quick Start Guide
|
|
```bash
|
|
# Understand the process
|
|
cat OPUS_QUICKSTART.md
|
|
```
|
|
|
|
### Step 3: Send to Opus 4.5
|
|
1. Copy entire content of `OPUS_PROMPT_PHASE1.md`
|
|
2. Paste into Claude Opus 4.5
|
|
3. Add instruction from `OPUS_QUICKSTART.md`
|
|
4. Let Opus scaffold Job-Info-Prod
|
|
|
|
### Step 4: After Scaffolding
|
|
1. Review output
|
|
2. Move to `/home/admin/Job-Info-Prod/`
|
|
3. Commit to git
|
|
4. Proceed to Sonnet 4.5 for implementation
|
|
|
|
---
|
|
|
|
## 🏗️ Architecture Summary
|
|
|
|
### Dual-Token System
|
|
- **PocketBase Token** - App operations (jobs, files, notes)
|
|
- **Microsoft Graph Token** - SharePoint/Office 365 integration
|
|
- Both obtained in single OAuth flow
|
|
- Always kept fresh via background refresh loop
|
|
|
|
### Key Requirements
|
|
✅ Zero re-authentication after initial login
|
|
✅ Always-warm token cache (30-min refresh loop)
|
|
✅ Offline-first with graceful degradation
|
|
✅ Field-worker reliability (mission-critical)
|
|
✅ Dual storage (localStorage + Valkey cache)
|
|
|
|
---
|
|
|
|
## 📊 Documentation Metrics
|
|
|
|
- **Total Files:** 13 documents
|
|
- **Total Lines:** ~4,000 lines
|
|
- **Architecture Diagrams:** 6 (in FLOWMAP.md)
|
|
- **Code Examples:** 10+
|
|
- **UI Specifications:** 5 (in VIEWS.md)
|
|
- **Coverage:** 100% (requirements, architecture, patterns)
|
|
|
|
---
|
|
|
|
## 🎯 Success Criteria
|
|
|
|
### After Opus Scaffolding
|
|
- ✅ All folders created
|
|
- ✅ All files scaffolded
|
|
- ✅ TypeScript compiles with no errors
|
|
- ✅ All imports resolve
|
|
- ✅ Service signatures correct
|
|
- ✅ Routes match specification
|
|
|
|
### After Sonnet Implementation
|
|
- ✅ Login flow works end-to-end
|
|
- ✅ Both tokens obtained
|
|
- ✅ Background refresh running
|
|
- ✅ API calls work
|
|
- ✅ Offline mode works
|
|
|
|
### After Deployment
|
|
- ✅ Workers authenticate once
|
|
- ✅ No re-authentication needed
|
|
- ✅ App works offline
|
|
- ✅ Graceful when backend down
|
|
- ✅ Mission-critical reliability achieved
|
|
|
|
---
|
|
|
|
## 📁 Folder Structure
|
|
|
|
```
|
|
instructions/
|
|
├── README.md (This file)
|
|
├── OPUS_PROMPT_PHASE1.md (Main prompt for Opus)
|
|
├── OPUS_QUICKSTART.md (How to use Opus)
|
|
├── MIGRATION_READY.md (Migration plan)
|
|
├── PRODUCTION_MIGRATION_PLAN.md (Implementation roadmap)
|
|
├── PROJECT_STATUS.md (Complete overview)
|
|
├── ARCHITECTURE_CONFIRMED.md (Architecture status)
|
|
├── DOCUMENTATION_COMPLETE.md (Completion summary)
|
|
├── DOCUMENTATION_OVERVIEW.md (Full documentation overview)
|
|
├── FINAL_CHECKLIST.md (Launch checklist)
|
|
└── auth/
|
|
├── README.md (Documentation overview)
|
|
├── INDEX.md (Navigation guide)
|
|
├── ONBOARDING.md (Getting started)
|
|
├── RULES.md (Implementation rules)
|
|
├── FLOWMAP.md (Architecture diagrams)
|
|
├── VIEWS.md (UI specifications)
|
|
├── TECH_STACK.md (Technology enforcement)
|
|
├── DOCUMENTATION_SUMMARY.md (What was created)
|
|
├── auth-universal.js (Base auth module)
|
|
└── auth-test.html (Auth testing page)
|
|
```
|
|
|
|
---
|
|
|
|
## ⚡ Timeline
|
|
|
|
| Phase | Task | Duration | Tool |
|
|
|-------|------|----------|------|
|
|
| 1 | Scaffolding | 30 min | Opus 4.5 |
|
|
| 2 | Implementation | 4-6 hrs | Sonnet 4.5 |
|
|
| 3 | Testing | 2-3 hrs | Manual |
|
|
| 4 | Deployment | 1-2 hrs | Manual |
|
|
| **Total** | | **8-12 hours** | |
|
|
|
|
---
|
|
|
|
## 🔗 Key Links
|
|
|
|
- **Job-Info-Test** (Current): `/home/admin/Job-Info-Test/` (will be replaced)
|
|
- **Job-Info-Prod** (Staging): `/home/admin/Job-Info-Prod/` (temporary - for testing before takeover)
|
|
- **Instructions** (This Folder): `/home/admin/Job-Info-Test/instructions/`
|
|
|
|
**Migration Strategy:** Build in Job-Info-Prod → Verify it works → Replace Job-Info-Test entirely
|
|
|
|
---
|
|
|
|
## ❓ Questions?
|
|
|
|
All documentation is cross-referenced and comprehensive. Start with:
|
|
1. `OPUS_QUICKSTART.md` - Understand the process
|
|
2. `OPUS_PROMPT_PHASE1.md` - The full specification
|
|
3. `auth/INDEX.md` - Navigate supporting docs
|
|
|
|
---
|
|
|
|
**Status: ✅ READY FOR OPUS 4.5 SCAFFOLDING**
|
|
|
|
Everything needed to build Job-Info-Prod is in this folder.
|