Skip to main content

GrantMaster Documentation

Welcome to the GrantMaster technical documentation. This comprehensive resource helps you understand the architecture, features, and development practices for the GrantMaster platform.

What is GrantMaster?

GrantMaster is a comprehensive grant management platform built with React, TypeScript, Firebase, and modern web technologies. It provides tools for managing grant-funded projects, tracking time and expenses, handling compliance, and generating reports.

Documentation Structure

🏗️ Architecture

Core technical specifications and architectural patterns:
  • System architecture and design patterns
  • Error handling and validation
  • Service layer patterns
  • Repository pattern for database abstraction

✨ Features

Detailed documentation for specific modules:
  • Impact & Monitoring Evaluation (M&E)
  • Grant Management
  • Partner Programs
  • Widget System
  • Dashboard Templates

🔌 Integrations

Third-party service integrations:
  • Stripe payments
  • Postmark email service
  • Notification systems
  • HubSpot CRM

📚 Guides

Step-by-step guides and best practices:
  • Development workflows
  • Testing strategies
  • UI/UX patterns
  • Accessibility guidelines

🚀 Getting Started

Initial setup and onboarding:
  • Environment setup
  • Firebase configuration
  • Deployment procedures

Technology Stack

  • Frontend: React 18 + TypeScript + Vite
  • Styling: Tailwind CSS + shadcn/ui components
  • Backend: Firebase (Auth, Firestore, Storage, Cloud Functions)
  • AI: Google Gemini API
  • Email: Postmark
  • Notifications: Novu
  • Error Tracking: Sentry

Contributing

When adding new documentation:
  1. Place files in the appropriate directory
  2. Use relative links for cross-references
  3. Follow markdown best practices
  4. Update navigation in docs.json