Skip to content

ASUCICREPO/Scottsdale-AI-plan-review

Repository files navigation

Scottsdale AI Building Review

This solution for the City of Scottsdale streamlines its pool plan review process by using LLMs to automatically check submitted plans against a set of predefined criteria divided in sequential steps to create a report that can be used by city planners and reviewers. This allows them to reduce time spent on basic checks and focus on more complex aspects of the review.

user interface


Disclaimers

Customers are responsible for making their own independent assessment of the information in this document. This document:

(a) is for informational purposes only,

(b) references AWS product offerings and practices, which are subject to change without notice,

(c) does not create any commitments or assurances from AWS and its affiliates, suppliers or licensors. AWS products or services are provided "as is" without warranties, representations, or conditions of any kind, whether express or implied. The responsibilities and liabilities of AWS to its customers are controlled by AWS agreements, and this document is not part of, nor does it modify, any agreement between AWS and its customers, and

(d) is not to be considered a recommendation or viewpoint of AWS.

Additionally, you are solely responsible for testing, security and optimizing all code and assets on GitHub repo, and all such code and assets should be considered:

(a) as-is and without warranties or representations of any kind,

(b) not suitable for production environments, or on production or other critical data, and

(c) to include shortcuts in order to support rapid prototyping such as, but not limited to, relaxed authentication and authorization and a lack of strict adherence to security best practices.

All work produced is open source. More information can be found in the GitHub repo.


Index Description
High Level Architecture High level overview illustrating component interactions
Deployment How to deploy the project
User Guide The working solution
Directories General project directory structure
API Documentation Documentation on the API the project uses
Credits Meet the team behind the solution
License License details

High-Level Architecture

The following architecture diagram illustrates the various AWS components utilized to deliver the solution. For an in-depth explanation of the backend, please look at the Architecture Guide.

Architecture Diagram

Deployment Guide

To deploy this solution, please follow the steps laid out in the Deployment Guide

User Guide

Please refer to the Web App User Guide for instructions on using the web app.

Directories

├── Backend/
│   └── AI-Scottsdale-plan-review-v1-backend/
│       ├── bin/
│       ├── lambda/
│       ├── lib/
│       └── s3-file-add-reference/

├── docs/
│   ├── architectureDeepDive.md
│   ├── deploymentGuide.md
│   ├── userGuide.md
│   └── media/

├── frontend/
│   ├── public/
│   └── src/
│       ├── Assets/
│       ├── Components/
│       ├── config/
│       ├── contexts/
│       ├── Pages/
│       ├── services/
│       └── utils/

├── buildspec.yml
├── full-deploy.sh
├── LICENSE
└── README.md

  1. Backend/AI-Scottsdale-plan-review-v1-backend: AWS CDK app and backend code
    • bin/: CDK app entry point (stack instantiation)
    • lib/: CDK stacks and constructs (infrastructure as code)
    • lambda/: Lambda functions and triggers used by the backend
    • s3-file-add-reference/: Reference files uploaded to S3 (e.g., pool template PDF used by engineering checks)
  2. docs/: Architecture, deployment, and user guides with media assets
  3. frontend/: React web application
    • src/Assets, Components, config, contexts, Pages, services, utils: App code and assets
    • public/: Static assets served by the app
  4. Root: Full deployment script, buildspec for code build, License and Readme (buildspec.yml, full-deploy.sh, LICENSE, README.md)

API Documentation

Here you can learn about the API the project uses: API Documentation.

Modification Guide

Steps to implement optional modifications such as changing the bedrock Model, adding more checks, or changing the frontend can be found here.

Credits

This application was architected and developed by Loveneet Singh, Syna Malhan, and Omdevsinh zala, with solutions architect Arun Arunachalam, program manager Thomas Orr and product manager Rachel Hayden. Thanks to the ASU Cloud Innovation Centre Technical and Project Management teams for their guidance and support.

License

This project is distributed under the MIT License.

About

AI agent powered plan review system for the City of Scottsdale that automatically checks submitted pool plans against predefined criteria and generates detailed reports, helping city reviewers save time and focus on complex decisions.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors