Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

6 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

City Permitting Portal

A modern web application built with the U.S. Web Design System (USWDS) for streamlined government permit applications and tracking.

Overview

This application provides citizens with an intuitive interface to:

  • Apply for various types of permits (building, electrical, plumbing, mechanical)
  • Track application status in real-time
  • View application history and dashboard
  • Access required forms and documentation

Features

πŸ›οΈ Government-Compliant Design

  • Built with USWDS 3.7.1 for accessibility and consistency
  • Section 508 compliant
  • Mobile-responsive design
  • Clear information hierarchy

πŸ“ Permit Application System

  • Multi-step application forms
  • Document upload functionality
  • Real-time form validation
  • Draft saving capability

πŸ“Š Dashboard & Tracking

  • User dashboard with application statistics
  • Real-time status updates
  • Application timeline visualization
  • Search functionality for tracking permits

πŸ” User Management

  • Secure user authentication
  • Role-based access (citizens, staff, administrators)
  • Application history tracking

Application Architecture

graph TB
    subgraph "Frontend Layer"
        A[HTML/CSS/JS<br/>USWDS Components]
        B[Responsive Design<br/>Mobile/Desktop]
        C[Accessibility Features<br/>Section 508 Compliant]
    end
    
    subgraph "Application Layer"
        D[Permit Application Forms]
        E[Status Tracking System]
        F[Document Management]
        G[User Dashboard]
        H[Notification System]
    end
    
    subgraph "Business Logic Layer"
        I[Application Processing]
        J[Workflow Management]
        K[Validation Engine]
        L[Fee Calculation]
        M[Review Assignment]
    end
    
    subgraph "Data Layer"
        N[(User Database)]
        O[(Permit Applications)]
        P[(Document Storage)]
        Q[(Configuration Data)]
        R[(Audit Logs)]
    end
    
    subgraph "Integration Layer"
        S[Payment Gateway]
        T[Email Service]
        U[GIS System]
        V[Code Compliance DB]
    end
    
    subgraph "External Systems"
        W[Tax Assessor Database]
        X[Building Code Database]
        Y[Contractor License Verification]
        Z[Property Records]
    end
    
    A --> D
    B --> E
    C --> F
    D --> I
    E --> J
    F --> K
    G --> L
    H --> M
    
    I --> N
    J --> O
    K --> P
    L --> Q
    M --> R
    
    I --> S
    J --> T
    K --> U
    L --> V
    
    U --> W
    V --> X
    M --> Y
    K --> Z
    
    classDef frontend fill:#e1f5fe
    classDef application fill:#f3e5f5
    classDef business fill:#e8f5e8
    classDef data fill:#fff3e0
    classDef integration fill:#fce4ec
    classDef external fill:#f1f8e9
    
    class A,B,C frontend
    class D,E,F,G,H application
    class I,J,K,L,M business
    class N,O,P,Q,R data
    class S,T,U,V integration
    class W,X,Y,Z external
Loading

Technology Stack

  • Frontend: HTML5, CSS3, JavaScript
  • UI Framework: U.S. Web Design System (USWDS) 3.7.1
  • Responsive Design: CSS Grid and Flexbox
  • Accessibility: WCAG 2.1 AA compliant
  • Icons: USWDS Icon Library
  • Forms: Native HTML5 form validation

Application Flow

Permit Application Process

flowchart TD
    A[User Login] --> B[Select Permit Type]
    B --> C[Fill Application Form]
    C --> D[Upload Documents]
    D --> E[Review & Submit]
    E --> F[Payment Processing]
    F --> G[Application Submitted]
    
    G --> H[Initial Review]
    H --> I{Complete?}
    I -->|No| J[Request Additional Info]
    J --> K[User Provides Info]
    K --> H
    I -->|Yes| L[Technical Review]
    
    L --> M{Code Compliant?}
    M -->|No| N[Rejection with Feedback]
    M -->|Yes| O[Site Inspection Required?]
    O -->|No| P[Approve Permit]
    O -->|Yes| Q[Schedule Inspection]
    Q --> R[Conduct Inspection]
    R --> S{Pass Inspection?}
    S -->|No| T[Require Corrections]
    T --> Q
    S -->|Yes| P
    
    P --> U[Issue Permit]
    N --> V[Application Closed]
    U --> W[Permit Active]
    
    classDef userAction fill:#e3f2fd
    classDef systemProcess fill:#f1f8e9
    classDef decision fill:#fff3e0
    classDef terminal fill:#fce4ec
    
    class A,B,C,D,E,K userAction
    class F,G,H,J,L,Q,R,U systemProcess
    class I,M,O,S decision
    class N,P,V,W terminal
Loading

User Roles & Permissions

Citizens

  • Submit permit applications
  • Track application status
  • Upload required documents
  • View application history
  • Receive notifications

Staff Reviewers

  • Review applications for completeness
  • Conduct technical reviews
  • Request additional information
  • Schedule inspections
  • Update application status

Administrators

  • Manage user accounts
  • Configure permit types and fees
  • Generate reports
  • System maintenance

File Structure

/
β”œβ”€β”€ index.html              # Main application page
β”œβ”€β”€ README.md              # This file
β”œβ”€β”€ assets/
β”‚   β”œβ”€β”€ css/
β”‚   β”‚   └── custom.css     # Custom styles
β”‚   β”œβ”€β”€ js/
β”‚   β”‚   └── app.js         # Application JavaScript
β”‚   └── images/
β”œβ”€β”€ forms/
β”‚   β”œβ”€β”€ building-permit.html
β”‚   β”œβ”€β”€ electrical-permit.html
β”‚   └── plumbing-permit.html
└── docs/
    β”œβ”€β”€ api-documentation.md
    └── deployment-guide.md

Getting Started

  1. Clone the repository
  2. Open index.html in a web browser
  3. The application uses CDN links for USWDS, so no build process is required for basic functionality

Features Implemented

βœ… Current Features

  • Responsive design with USWDS components
  • Multi-section permit application form
  • Application dashboard with status cards
  • Timeline visualization for application tracking
  • Document upload interface
  • Status tracking system
  • Accessibility features

🚧 Future Enhancements

  • Backend API integration
  • Real-time notifications
  • Payment processing
  • Advanced search and filtering
  • Bulk operations for staff
  • Mobile app companion
  • Integration with GIS systems
  • Automated code compliance checking

Browser Support

  • Chrome 90+
  • Firefox 88+
  • Safari 14+
  • Edge 90+
  • Mobile browsers (iOS Safari, Chrome Mobile)

Accessibility

This application is built to meet:

  • WCAG 2.1 AA standards
  • Section 508 compliance
  • Keyboard navigation support
  • Screen reader compatibility
  • High contrast mode support

Contributing

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

License

This project is in the public domain and is not subject to copyright restrictions.

Support

For technical support or questions about the application:


Built with ❀️ using the U.S. Web Design System

About

USWDS-based permitting application created via MCP server

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages