docs: add system architecture and design overview

[AditiSah05]

Summary

This pull request establishes comprehensive system architecture documentation for BHV, providing detailed technical specifications for all major system components and design decisions.

Motivation

Healthcare software projects require thorough architectural documentation to ensure code quality, facilitate team collaboration, and support compliance requirements. This documentation provides the technical foundation necessary for professional development and system maintenance.

Changes Made

Architecture Documentation Added

• System Architecture Overview: Complete technical specification document covering all system layers and component interactions
• Backend Architecture: Detailed Flask application structure, core components, and business logic organization
• Frontend Architecture: Minimal template system design with Jinja2 templates and healthcare-appropriate interface specifications
• Image Storage System: File system organization, storage features, and access control mechanisms
• Database Schema: Complete relational database design for users, images, narratives, and administrative audit trails

Technical Specifications

• User Role Definitions: Comprehensive capabilities and restrictions for patient and administrator roles
• Security Architecture: Authentication, authorization, file security, and data protection specifications
• Deployment Architecture: Single-command deployment process and healthcare network considerations

Technical Impact

• Provides complete system blueprint for development team alignment
• Establishes security and compliance framework for healthcare deployment
• Documents scalability and maintenance considerations
• Enables informed architectural decisions for future development phases

Validation

• Architecture reviewed for healthcare compliance considerations
• Database schema designed for scalability and data integrity
• Security specifications aligned with healthcare data protection requirements
• Documentation structured for professional development team consumption

This contribution establishes the comprehensive architectural foundation necessary for professional healthcare software development while maintaining BHV's core principles of simplicity and deployment efficiency.

[gemini-code-assist]

Summary of Changes

Hello @AditiSah05, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the project's documentation by establishing a foundational system architecture and design overview for BHV. It provides a clear blueprint for development, ensuring alignment, facilitating collaboration, and addressing compliance requirements crucial for healthcare software. The changes introduce detailed technical specifications across various system layers, from backend and frontend design to data storage, security, and deployment, thereby laying a robust groundwork for future development and maintenance.

Highlights

• Comprehensive Architectural Documentation: Introduced a detailed system architecture document covering all layers, components, and design decisions for BHV, emphasizing simplicity, security, and maintainability.
• Backend and Frontend Architecture: Documented the Flask-based backend, including core components, authentication, file processing, and database operations, alongside a minimal Jinja2 template-based frontend design.
• Image Storage and Database Schema: Detailed the file system organization for image storage, including thumbnail generation and access control, and provided a complete relational database schema for users, images, narratives, and admin audit trails.
• User Roles, Security, and Deployment: Defined comprehensive user roles (patient and administrator) with their respective capabilities and restrictions, outlined the security architecture for authentication, file security, and data protection, and described a single-command deployment process tailored for healthcare networks.
• Setup and Environment Guide: Added a new guide detailing environment setup, required system dependencies, configuration using a .env file, quick start instructions, and crucial security notes for deployment.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request introduces comprehensive system architecture and setup documentation, which is an excellent and crucial step for the project's maintainability and clarity. The documentation is well-structured and detailed. My review focuses on enhancing the security, correctness, and consistency of the provided information. I've identified a potential security risk with the default SECRET_KEY in the example environment file, a technical inaccuracy in the database schema definition for SQLite, and a couple of points in the architecture document that could be clarified to avoid ambiguity regarding database encryption and metadata storage.