https://github.com/moduscreateorg/app-med-ai-gen
https://github.com/moduscreateorg/app-med-ai-gen
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/moduscreateorg/app-med-ai-gen
- Owner: ModusCreateOrg
- License: mit
- Created: 2025-02-24T16:58:42.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-05-07T11:23:16.000Z (about 2 months ago)
- Last Synced: 2025-05-07T12:22:51.701Z (about 2 months ago)
- Language: TypeScript
- Size: 12.5 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Smart Medical Reports Explainer
[](./LICENSE)
[](https://moduscreate.com)
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:
- [Frontend](./frontend/README.md)
- [Getting Started](#getting-started)
- [How it Works](#how-it-works)
- [Developing](#developing)
- [Prerequisites](#prerequisites)
- [Docker Setup](#docker-setup)
- [Testing](#testing)
- [Contributing](#contributing)
- [Modus Create](#modus-create)
- [Licensing](#licensing)
# Getting Started
To run the application using Docker:
```bash
# 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:
- Frontend: http://localhost:5173
- Backend API: http://localhost:3000
# 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:
```bash
npm run clean
npm run dev
```
2. For port conflicts:
```bash
# Find the process using the port
sudo lsof -i :3000 # or :5173
# Kill the process
kill -9
```
3. View container logs:
```bash
# All containers
docker compose logs
# Specific service
docker compose logs backend
docker compose logs frontend
```
## Testing
{Notes on testing}
## Contributing
See [Contribution Guidelines](.github/CONTRIBUTING.md) and [Code of Conduct](.github/CODE_OF_CONDUCT.md).
# Modus Create
[Modus Create](https://moduscreate.com) 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.
This project is part of [Modus Labs](https://labs.moduscreate.com/?utm_source=labs&utm_medium=github&utm_campaign=PROJECT_NAME).
# Licensing
This project is [MIT licensed](./LICENSE).