Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

DOCUMENTS Folder

This folder consolidates all project documentation files for XAH Payroll.

Structure

DOCUMENTS/
├── README.md                           # This file
├── CONTEXT_IMPLEMENTATION.md           # React Context implementation checklist
├── DATABASE_SETUP.md                   # Database setup guide
├── DEPLOYMENT_COMPARISON.md            # Deployment strategy comparison
├── NETWORK_CONFIG.md                   # Network switching instructions
├── OPEN_SOURCE_PREPARATION.md          # Open source preparation checklist
├── QUICKSTART.md                       # Quick start guide
├── QUICK_REFERENCE.md                  # Quick reference guide
├── TERMS_OF_SERVICE.md                 # Terms of service
├── TEST_COMPREHENSIVE_SUITE.md         # Comprehensive test suite
├── TEST_QUICK_VALIDATION.md            # Quick validation tests
├── WALLET_INTEGRATION.md               # Wallet integration details
├── backend/                            # Backend-specific documentation
│   ├── CRON_SETUP.md                   # Cron job configuration
│   └── README.md                       # Backend overview
├── frontend/                           # Frontend-specific documentation
│   └── README.md                       # Frontend overview
└── scripts/                            # Script documentation
    └── test-auto-clear-on-closure.md   # Auto-clear on closure test

Top-Level Documentation

The following documentation files remain at the project root for easy access:

  • README.md - Main project README
  • CLAUDE.md - Claude Code project guidance

Navigation

  • Getting Started: See QUICKSTART.md or root README.md
  • Database Setup: See DATABASE_SETUP.md (comprehensive guide with details)
  • Open Source Preparation: See OPEN_SOURCE_PREPARATION.md for complete checklist
  • Testing: See TEST_QUICK_VALIDATION.md or TEST_COMPREHENSIVE_SUITE.md
  • Backend Documentation: See backend/ subdirectory
  • Frontend Documentation: See frontend/ subdirectory
  • Scripts: See scripts/ subdirectory for test scripts and utilities