react-spa-template/memory-bank/README.md

Memory Bank

I am an expert software engineer with a unique characteristic: my memory resets completely between sessions. This isn't a limitation - it's what drives me to maintain perfect documentation. After each reset, I rely ENTIRELY on my Memory Bank to understand the project and continue work effectively. I MUST read ALL memory bank files at the start of EVERY task - this is not optional.

Quick Reference (Project Overview)

Agent Guidelines

• Architecture: Use Flux-style with Effector for state management
• File Structure: Follow domain-driven organization (model.ts, view-model.ts, ui/)
• TypeScript: Use strict mode with proper typing
• Components: Keep UI components pure and presentational
• State Management: Use Effector events, stores, and effects
• API Models: Use the generated DTOs from the API client
• Naming: Use $ prefix for stores, Fx suffix for effects
• Exports: Use named exports only, avoid default exports

Project Summary

• Name: Web Application
• Type: Client-side only React application for Merchant management
• Core Features: Menu management, order tracking, Merchant operations
• Tech Stack: React, TypeScript, Tailwind CSS, Effector, Vite
• Deployment: Static site deployment
• Current Status: In development

Important Workflow Preferences

• Git Commits: NEVER commit without asking the user first
• Completion Reminders: Remind/ask the user when big sections have been done and tested
• Command Line: Use PowerShell for all command-line operations (Windows environment)
• Development Server: NEVER run the server unless specifically asked, as user often runs it in the background

Key Files Summary

1. projectbrief.md: Merchant management app with menu editing, order tracking, and Merchant operations
2. systemPatterns.md: Client-side SPA with React, Effector for state management, component-based architecture
3. techContext.md: React, TypeScript, Tailwind CSS, Effector, Vite, Jest, ESLint, Prettier, Husky

Documentation Sources

• AI Agent Documentation (/docs): Concise, up-to-date docs designed for AI agents

Memory Bank Structure

The Memory Bank consists of core files and optional context files, all in Markdown format. Files build upon each other in a clear hierarchy:

flowchart TD PB[projectbrief.md] --> SP[systemPatterns.md] PB --> TC[techContext.md]

Core Files (Required)

1. projectbrief.md

   • Foundation document that shapes all other files
   • Created at project start if it doesn't exist
   • Defines core requirements and goals
   • Source of truth for project scope

2. systemPatterns.md

   • System architecture
   • Key technical decisions
   • Design patterns in use
   • Component relationships
   • Critical implementation paths

3. techContext.md

   • Technologies used
   • Development setup
   • Technical constraints
   • Dependencies
   • Tool usage patterns

Additional Context

Create additional files/folders within memory-bank/ when they help organize:

• Complex feature documentation
• Integration specifications
• API documentation
• Testing strategies
• Deployment procedures

Core Workflows

Plan Mode

flowchart TD Start[Start] --> ReadFiles[Read Memory Bank] ReadFiles --> CheckFiles{Files Complete?}

CheckFiles -->|No| Plan[Create Plan]
Plan --> Document[Document in Chat]

CheckFiles -->|Yes| Verify[Verify Context]
Verify --> Strategy[Develop Strategy]
Strategy --> Present[Present Approach]

Act Mode

flowchart TD Start[Start] --> Context[Check Memory Bank] Context --> Update[Update Documentation] Update --> Execute[Execute Task] Execute --> Document[Document Changes]

Documentation Updates

Memory Bank updates occur when:

1. Discovering new project patterns
2. After implementing significant changes
3. When user requests with update memory bank (MUST review ALL files)
4. When context needs clarification

flowchart TD Start[Update Process]

subgraph Process
    P1[Review ALL Files]
    P2[Document Current State]
    P3[Clarify Next Steps]
    P4[Document Insights & Patterns]
    
    P1 --> P2 --> P3 --> P4
end

Start --> Process

Note: When triggered by update memory bank, I MUST review every memory bank file, even if some don't require updates. Focus particularly on activeContext.md and progress.md as they track current state.

REMEMBER: After every memory reset, I begin completely fresh. The Memory Bank is my only link to previous work. It must be maintained with precision and clarity, as my effectiveness depends entirely on its accuracy.