MacPro Mako Documentation Index

Welcome to the MacPro Mako documentation! This guide will help you understand the codebase and get started with development.

📚 Documentation Files

🏁 Start Here

• README - Comprehensive overview of the codebase, architecture, and setup instructions
• Quick Reference - Essential commands, concepts, and quick lookup information
• Setup Checklist - Step-by-step setup checklist for local and AWS deployment
• Code Structure & Technology Analysis - In-depth analysis of the code structure, technology stack, and architecture

🚀 Quick Start Guide

For New Developers

1. Read the Overview: Start with README to understand the project architecture and technology stack
2. Follow the Setup: Use Setup Checklist to set up your development environment
3. Keep the Reference Handy: Use Quick Reference for daily development tasks
4. Deep Dive: See Code Structure & Technology Analysis for a detailed breakdown of the codebase

For Experienced Developers

1. Skip to Quick Reference: Use Quick Reference for immediate command lookup
2. Review Architecture: Check README for architecture details
3. Verify Setup: Use Setup Checklist to ensure everything is configured correctly
4. Explore Structure: See Code Structure & Technology Analysis for advanced structure and technology analysis

📖 Documentation Sections

• Documentation Index
• Quick Reference
• README
• Setup Checklist
• Code Structure & Technology Analysis

📄 Section Descriptions

Documentation Index

A navigation guide to all major documentation files and resources.

Quick Reference

A cheat sheet of essential commands, concepts, and file locations for daily development.

README

A comprehensive overview of the project, including architecture, setup, and workflow.

Setup Checklist

A step-by-step checklist for setting up your local and AWS environments.

Code Structure & Technology Analysis

A deep dive into the codebase structure, technology stack, and architectural patterns.

🏆 What You'll Learn

Technology Stack

• Frontend: React 18, TypeScript, Vite, Tailwind CSS
• Backend: AWS Lambda, API Gateway, OpenSearch
• Infrastructure: AWS CDK, CloudFormation
• DevOps: Bun, Turbo, Vitest, Playwright

Key Concepts

• Monorepo Architecture: Multiple projects in one repository
• Infrastructure as Code: AWS resources defined in TypeScript
• Serverless Architecture: No server management required
• Type Safety: Full TypeScript coverage
• Feature Flags: LaunchDarkly integration

🛠️ Common Tasks

Development

# Start development
bun run bun:dev

# Run tests
bun run test

# Deploy to AWS
cdk deploy -c stage=local

Troubleshooting

• Check Setup Checklist for common issues
• Review Quick Reference for commands
• See README for detailed explanations

📖 Documentation Structure

docout/
├── INDEX.md              # This file - navigation guide
├── README.md             # Comprehensive documentation
├── QUICK_REFERENCE.md    # Essential commands & concepts
└── SETUP_CHECKLIST.md    # Step-by-step setup guide

🔗 External Resources

Official Documentation

• AWS CDK Documentation
• React Documentation
• TypeScript Handbook
• Bun Documentation
• Vite Documentation

Project Resources

• GitHub Repository: Enterprise-CMCS/macpro-mako
• AWS Console: https://console.aws.amazon.com/

🤝 Getting Help

Before Asking for Help

1. Check this documentation
2. Review the troubleshooting sections
3. Search existing GitHub issues
4. Check AWS CDK and React documentation

When You Need Help

1. Provide specific error messages
2. Include your environment details
3. Share relevant code snippets
4. Mention which documentation you've already checked

📝 Contributing to Documentation

If you find issues or want to improve this documentation:

1. Update the relevant file in the docout/ directory
2. Test your changes by following the setup instructions
3. Submit a pull request with clear descriptions
4. Update this index if you add new files

🎉 Welcome to MacPro Mako!

You're now ready to start developing with MacPro Mako. The documentation is designed to help you:

• Understand the codebase architecture
• Set up your development environment quickly
• Deploy to AWS with confidence
• Troubleshoot common issues
• Contribute effectively to the project

Happy coding! 🚀

Last updated: [Current Date] Documentation version: 1.1

Quick Reference Guide - MacPro Mako

Essential Technologies & Concepts

🚀 Core Technologies

MacPro Mako - Codebase Analysis & Setup Guide

Table of Contents

1. Project Overview
2. Architecture Overview
3. Technology Stack
4. Key Concepts Explained
5. Project Structure
6. Local Development Setup
7. AWS Deployment Setup
8. Development Workflow
9. Testing Strategy
10. Troubleshooting

Setup Checklist - MacPro Mako

🏠 Local Development Setup

Prerequisites Installation

• Node.js (v18 or higher)

  node --version
                          # Should show v18.x.x or higher
                          

MacPro Mako - Code Structure & Technology Analysis

🏗️ Overall Architecture

MacPro Mako is a full-stack government healthcare application built with modern cloud-native technologies. It follows a monorepo architecture with clear separation between frontend, backend, and infrastructure components.