Smart Clinical Reporting Workspace

An AI-assisted clinical documentation workspace with a TypeScript/React frontend and a Python/FastAPI backend. The project appears to be organized for generating and managing structured clinical reports, with support for modern AI SDK integrations.

Repository Structure

Smart-Clinical-Reporting-Workspace/
├── frontend/   # React + TypeScript + Vite client app
└── backend/    # FastAPI + SQLAlchemy API service

Tech Stack

Frontend (frontend/)

• React 19 + TypeScript
• Vite (dev/build tooling)
• Tailwind CSS
• Zustand (state management)
• Firebase
• Google GenAI SDK (@google/genai)

Backend (backend/)

• FastAPI + Uvicorn
• SQLAlchemy
• Alembic (migrations)
• Pydantic / pydantic-settings
• Auth/security libraries (passlib, python-jose)
• AI client SDKs (openai, google-generativeai, groq)

Quick Start

1) Clone the repository

git clone https://github.com/Kishore-Krish19/Smart-Clinical-Reporting-Workspace.git
cd Smart-Clinical-Reporting-Workspace

---

Frontend Setup

cd frontend
npm install

Create your environment file from template:

cp .env.example .env.local

Then set required values (for example GEMINI_API_KEY) in .env.local.

Run the frontend:

npm run dev

By default, Vite is configured to run on:

• http://0.0.0.0:3000

---

Backend Setup

From repository root:

cd backend

Create and activate virtual environment.

Windows (PowerShell)

python -m venv venv
.\venv\Scripts\Activate.ps1

macOS/Linux

python3 -m venv venv
source venv/bin/activate

Install dependencies:

pip install -r requirements.txt

Run backend API server:

uvicorn app.main:app --reload

Default backend URL:

• API: http://127.0.0.1:8000
• Docs (Swagger): http://127.0.0.1:8000/docs

If migrations are configured in your workflow:

alembic upgrade head

---

Development Notes

• There are existing submodule READMEs in both frontend/ and backend/ with additional setup details.
• frontend/src.zip and backend/sql_app.db are present in the repository; if these are development artifacts, consider adding/adjusting .gitignore rules and keeping only required assets in version control.
• The project language composition is predominantly TypeScript, with Python powering the API layer.

Suggested Next Improvements

• Add architecture diagram / request flow between frontend ↔ backend ↔ AI providers.
• Document environment variables for both frontend and backend in dedicated sections.
• Add scripts for running both services together (e.g., Makefile or root docker-compose).
• Add contribution guidelines and license information.

Status

This README was generated by analyzing the current repository layout and dependency manifests and is intended as a top-level onboarding guide.