Skip to content

ModusCreateOrg/app-med-ai-gen

 
 

Repository files navigation

Smart Medical Reports Explainer

MIT Licensed Powered by Modus_Create

AI-powered medical report translator that simplifies complex medical documents for patients and caregivers. This application helps users understand their health conditions, diagnoses, and test results without relying on unreliable online searches.

This project proposes an AI-powered medical report translator that simplifies complex medical documents for patients and caregivers. By leveraging AI-driven text extraction and natural language processing (NLP), the system translates medical jargon into plain language, helping users understand their health conditions, diagnoses, and test results without relying on unreliable online searches.

Application Workflow

Home Screen Document Upload Processing
Results Analysis Results Archive AI Integration

Project Packages

Package Description Status
Frontend Ionic/React mobile application Active
Backend API and ML services Planned

Getting Started

Please see individual package READMEs for setup instructions:

Getting Started

To run the application using Docker:

# Start all services npm run dev # Stop all services npm run down # Clean up everything (removes volumes and orphaned containers) npm run clean

The application will be available at:

How it works

The application consists of two main components:

  • A NestJS backend service that handles API requests and AI processing
  • A Vue.js frontend that provides the user interface

Both services are containerized using Docker for consistent development and deployment.

Developing

Prerequisites

  • Docker Engine 24.0.0+
  • Node.js 20.x+ (for local development)
  • npm 10.x+ (for local development)

Docker Setup

The project uses Docker Compose for development. The setup includes:

medical-reports-explainer/ ├── backend/ # NestJS backend application ├── frontend/ # Vue.js frontend application ├── docker-compose.yml # Docker services configuration └── package.json # Root level npm scripts 

Environment Variables

Backend:

NODE_ENV=development PORT=3000 

Frontend:

VITE_API_URL=http://backend:3000 

Troubleshooting

  1. If containers fail to start:
npm run clean npm run dev
  1. For port conflicts:
# Find the process using the port sudo lsof -i :3000 # or :5173 # Kill the process kill -9 <PID>
  1. View container logs:
# All containers docker compose logs # Specific service docker compose logs backend docker compose logs frontend

Testing

{Notes on testing}

Contributing

See Contribution Guidelines and Code of Conduct.

Modus Create

Modus Create is a digital product consultancy. We use a distributed team of the best talent in the world to offer a full suite of digital product design-build services; ranging from consumer facing apps, to digital migration, to agile development training, and business transformation.

Modus Create

This project is part of Modus Labs.

Modus Labs

Licensing

This project is MIT licensed.

About

No description, website, or topics provided.

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 8