Developer Guide

Learn how to build and run the application locally.

Get started

• Install
  • Prerequisites
• Add environment variables
• Front-end build variables
• Cross-origin requests
• Secrets
• Setup the Database
  • Deployed initialization
  • Local initialization
• Importing Research Files
  • Getting the files
  • Configuring the source
  • Running an import
  • Triggering an import over HTTP
  • What to expect
  • How it works
  • Troubleshooting
• Database Troubleshooting
  • Troubleshooting SQL Queries
  • Shell Configuration
• HTTP 500 Internal Server Error - Troubleshooting
  • Common Causes
  • Diagnostic Steps
  • Recovery

Run the application

• Run the application
  • FastAPI server
  • React frontend
• Python Beginner’s Guide - FastAPI Backend Setup
  • What is Python & FastAPI?
  • Prerequisites
  • Setting Up Your Development Environment
  • Understanding the Project Structure
  • Working with the Census Data API
  • Step-by-Step Tutorial
  • Common Python Concepts
  • Debugging and Troubleshooting
  • Next Steps
  • Helpful Commands Reference
• FastAPI Project - Development
  • Docker Compose
  • Email in local development
  • Local Development
  • Docker Compose files and env vars
  • The .env file
  • Pre-commits and code linting
  • URLs
• Testing
  • Prerequisites
  • Running Tests
  • Test Pre-start

Deploy

• Deploying on AWS
  • Why one instance
  • The instance
  • AWS configuration
  • The container files
  • Bringing up the instance
  • Backups
  • Costs
  • Operational notes
• Google Cloud

Security and Maintenance

• Security Emergency Procedures
  • Forced Password Reset Strategy
  • Security Emergency Actions

Documentation

• Sphinx
• Storybook
• Frontend Components
  • Source of truth
  • Component stack
  • shadcn/ui configuration
  • Component directory structure
  • Recommended usage
  • Adding a new component
  • Related documentation
• README Extended Reference
  • Documentation workflows
  • Documentation troubleshooting
  • Frontend client generation
  • Frontend remote API configuration
  • Frontend Playwright tests
  • Backend operations
  • Database migrations
  • Related Developer Guide pages
• Test repository sync
  • Frontend
  • Backend
• WARP.md
  • Architecture
  • Common Commands

Explore the API

• API Reference
  • Application
  • Routes
  • Core
  • Assessment data model
  • Research file importer
  • Reporting services
  • Data models and CRUD
  • Utilities