Home

Welcome to the PermitProof technical documentation and developer guide.

📚 What is PermitProof?

PermitProof (formerly CodeProof aka Construction Code Expert) is a cloud-native GenAI platform that automates building permit review processes using Google Cloud Platform services. The application uses AI-powered analysis to streamline code compliance reviews, reducing the time and cost associated with traditional building permit processes.

🚀 Quick Links

• Wiki Implementation Guide - How this documentation site is built and deployed
• Production Readiness - System readiness assessment
• Production Readiness v2 - Detailed production readiness analysis

📖 Documentation Sections

Technical Design Documents (TDD)

Comprehensive technical design documents covering system architecture, reliability, and production readiness:

• Production Readiness Assessment
• Production Readiness v2 - Detailed Analysis
• Billing System Design

Implementation Guides

Step-by-step guides for implementing key features:

• RBAC Invite User Implementation
• Sharing Settings UI Implementation
• Sharing UI/UX Improvements
• Permission Caching Troubleshooting

Operational Documentation

• LLM Log Sanitization
• Wiki Implementation

Prompts

• Cloud Run Jobs Specification

🏗️ System Architecture

The Construction Code Expert follows a modern microservices architecture:

• Frontend: Angular 17+ with Material Design 3
• Backend: Java 23 with gRPC services
• Infrastructure: Google Cloud Platform (Cloud Run, Firestore, Cloud Storage)
• AI/ML: Vertex AI with Gemini models for code analysis

🔐 Key Features

• Document Processing: PDF architectural plan ingestion with OCR
• Code Analysis: Building code compliance assessment using RAG
• Real-time Collaboration: Multi-user project sharing with RBAC
• Cost Tracking: LLM usage monitoring and billing transparency

🛠️ For Developers

Repository Structure

construction-code-expert/
├── src/              # Java backend code
├── web-ng-m3/        # Angular frontend (latest)
├── docs/             # Documentation (this site's source)
├── cli/              # CLI tools and deployment scripts
└── env/              # Environment configurations

Getting Started

1. Clone the repository: GitHub - Construction Code Expert
2. Check the README in the repository root for setup instructions
3. Review the Production Readiness document for architecture overview

📝 Contributing to Documentation

This documentation is built with Docusaurus and automatically deployed to GCS. To contribute:

1. Edit markdown files in the docs/ folder
2. Commit your changes - the git hook will automatically sync
3. Deploy with: ./cli/sdlc/wiki/deploy-to-gcs.sh

See the Wiki Implementation Guide for details.

📞 Support

For questions or issues:

• Open an issue on GitHub
• Review the troubleshooting guides in this documentation
• Check the implementation guides for specific features

---

Last Updated: 2025
Project Status: Active Development