Skip to content

A medical imaging and report search system.

License

Notifications You must be signed in to change notification settings

yangszwei/koala

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Koala

A medical imaging and report search system.


Koala is a full-stack application for searching and organizing medical studies and reports. It leverages a Go backend and a modern Vite/React frontend, integrates FHIR and DICOMweb standards, and is powered by Elasticsearch for efficient querying.

🌟 Features

  • 🔍 Search functionality for report content, modality, date range, patient details, and clinical categories
  • 💡 Autocomplete support for faster and more accurate query entry
  • 📄 Integration of FHIR DiagnosticReports with DICOMweb ImagingStudies
  • ⚙️ Go backend providing structured APIs for search and data access
  • 🖥️ Frontend built with Vite, React, and TailwindCSS for responsive user interfaces
  • 🐳 Docker-ready build process for containerized deployment

📦 How to Build

Build from Source

For users who prefer to build and host Koala manually without Docker:

Frontend

cd web
npm install
npm run build

This will generate static assets in the web/dist directory.

Backend

The backend requires the built frontend assets to compile successfully. Ensure you have the frontend built before proceeding.

go build -o koala cmd/koala/main.go

The compiled binary koala will be available in the project root.

Docker Build

To build and run using Docker:

docker build -t koala .

This will create a Docker image named koala. You can run it with:

docker run -p 8080:8080 -v "./config.yaml:/app/config.yaml" koala

⚙️ Configuration

Create a config.yaml file in your project root for custom configurations. See the config/default.yaml for example configurations.

Note: The .env file in /web is only used during frontend development to configure the Vite dev server. It does not affect backend configuration.

Headless Mode

To run Koala without the frontend (API-only mode), enable headless mode by setting the following in your config.yaml:

http:
  headless: true

In this mode, APIs are served without the /api prefix.

🛠️ Development Setup

Prerequisites

  • Go 1.21+
  • Node.js 20+

Clone the Repository

git clone https://github.com/yangszwei/koala.git
cd koala

Frontend

See web/README.md for detailed setup, or run:

cd web
npm install
npm run dev

Koala frontend will be available at http://localhost:5173.

Backend

go run cmd/koala/main.go

📜 License

This project is licensed under the Apache License 2.0. See the LICENSE file for details.

About

A medical imaging and report search system.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •