Refactor: Organize root directory structure for better maintainability

[rafamiziara]

Summary

Reorganize the root directory structure to follow monorepo best practices and improve maintainability.

Current Issues

• Configuration files scattered across root directory
• Development scripts mixed with business logic
• Documentation files cluttering root level
• Generated/temporary files in version control
• Shared utilities buried in package-specific folders

Proposed Structure

/
├── README.md              # Project overview
├── CLAUDE.md             # Development guidance  
├── LICENSE               # License file
├── package.json          # Root package config
├── pnpm-lock.yaml        # Lock file
├── pnpm-workspace.yaml   # Workspace config
├── tsconfig.json         # TypeScript config
├── .nycrc.json          # Coverage config (stays at root)
├── .eslintrc.cjs        # ESLint config (stays at root)
├── apps/                 # Applications
├── packages/             # Shared packages
├── coverage/             # Test coverage reports
├── docs/                 # 📁 NEW: All documentation
├── config/               # 📁 NEW: Configuration files  
└── scripts/              # 📁 NEW: Shared development scripts

Changes Included

Move to /docs/

• ROADMAP.md → docs/ROADMAP.md
• SPRINT_1_IMPLEMENTATION.md → docs/SPRINT_1_IMPLEMENTATION.md
• SPRINT_PLAN.md → docs/SPRINT_PLAN.md

Move to /config/

• firebase.json → config/firebase.json
• .firebaserc → config/.firebaserc
• firestore.indexes.json → config/firestore.indexes.json
• firestore.rules → config/firestore.rules
• tsconfig.dev.json → config/tsconfig.dev.json
• ngrok.yml.template → config/ngrok.yml.template

Move to /scripts/

• dev-start.js → scripts/dev-start.js
• packages/backend/scripts/generateKey.ts → scripts/generateKey.ts
• packages/backend/scripts/signMessage.ts → scripts/signMessage.ts

Package.json Updates

• Update Firebase commands to use --config-dir ./config
• Update dev script to use scripts/dev-start.js
• Update backend scripts to reference ../../scripts/

Security Improvements

• Add development keys to .gitignore
• Remove generated files from tracking
• Clean up temporary files

Benefits

✅ Professional Structure - Follows industry monorepo best practices
✅ Clear Separation - Configuration, documentation, and scripts organized
✅ Shared Utilities - Development tools accessible across all packages
✅ Cleaner Root - Only essential files at root level
✅ Better Security - Proper gitignore for sensitive files
✅ Easier Maintenance - Logical grouping makes navigation intuitive

Testing Checklist

• pnpm dev starts development environment correctly
• Firebase commands work with new config location
• Backend generateKey and signMessage scripts function
• All package builds and tests pass
• Mobile app can find assets and configurations

[rafamiziara]

✅ Directory refactoring completed successfully!

This issue has been resolved with commit 2f92268 which implements the complete root directory reorganization.

✅ What was completed:

Directory Structure

• ✅ Created directory for all configuration files
• ✅ Created directory for all documentation
• ✅ Enhanced directory for shared development utilities
• ✅ Clean root directory with only essential files

Files Moved

Configuration files → :

• , , ,
• ,

Documentation → :

• , ,

Development scripts → :

• , ,
• Made backend scripts accessible across all packages

Configuration Updates

• ✅ Updated Firebase commands to use
• ✅ Updated package.json scripts for new file locations
• ✅ Updated dev-start.js to reference config/ngrok.yml
• ✅ Updated ESLint ignore patterns

Security Improvements

• ✅ Added development keys to .gitignore
• ✅ Cleaned up generated/temporary files
• ✅ Proper handling of sensitive files

Sprint Tracking Updates

• ✅ Updated Sprint 1 implementation document
• ✅ Added issue Refactor: Organize root directory structure for better maintainability #41 to Foundation & Enhancement section
• ✅ Updated progress tracking to reflect smart contracts completion (82% overall progress)

🎯 Benefits Achieved:

• Professional monorepo structure following industry best practices
• Clear separation of concerns (config, docs, scripts)
• Shared development utilities accessible across all packages
• Cleaner root directory enhancing maintainability
• Better security with proper .gitignore patterns
• Easier navigation and maintenance

The directory structure is now professional, organized, and ready to support continued development! 🚀