Bahmni Apps Frontend

A React TypeScript monorepo application for Bahmni applications, built with Nx, Webpack, and Carbon Design System. This application includes PWA support for offline capabilities.

About Bahmni

Bahmni is an open-source healthcare information system designed to serve healthcare providers in resource-limited settings. It combines electronic medical records (EMR), hospital information management, and clinical workflows into a unified platform. Bahmni is built on OpenMRS and focuses on making healthcare delivery more efficient and patient-centric. The platform follows FHIR (Fast Healthcare Interoperability Resources) standards to ensure interoperability with other healthcare systems.

Features

• React - UI library for building user interfaces
• Carbon Design System - IBM's open-source design system
• Webpack - Module bundler for modern JavaScript applications
• React Router - Declarative routing for React applications
• i18n Support - Internationalization for multiple languages
• Display Controls - Reusable clinical data visualization components

Prerequisites

• Node.js (v18.x or later recommended)
• Yarn (v1.22.x or later recommended)

Getting Started

Installation

# Install dependencies
yarn

Detailed Setup Guide

For a comprehensive setup guide including development environments, Docker configuration, authentication setup, and troubleshooting, please refer to our Setup Guide.

Additional Documentation

• Frontend Architecture - A comprehensive overview of the Bahmni Apps Frontend architecture
• Project Structure - A high-level overview of the project structure
• i18n Guide - Internationalization implementation details
• Sortable Data Table Guide - Usage of the sortable data table component
• Global Notification Guide - Using the notification system

Building for Production

# Build the application
yarn build 

The build artifacts will be stored in the dist/ directory.

Development

# Start the development server
yarn nx serve distro

This will start the development server at http://localhost:3000.

Linting

# Run ESLint to check for code quality issues
yarn lint

# Fix ESLint issues automatically
yarn lint:fix

For a more detailed explanation of the project structure and architecture, see Architecture Documentation and Project Structure Documentation.

Scripts

• yarn dev - Start the development server
• yarn build - Build the application for production
• yarn test - Run tests
• yarn test:watch - Run tests in watch mode
• yarn test:coverage - Run tests with coverage report
• yarn lint - Run ESLint to check for code quality issues
• yarn lint:fix - Fix ESLint issues automatically
• yarn format - Format code with Prettier

Technologies

• React - UI library
• TypeScript - Type-safe JavaScript
• Carbon Design System - IBM's design system
• Webpack - Module bundler
• React Router - Routing library
• i18next - Internationalization framework
• Jest - Testing framework
• React Testing Library - React testing utilities
• ESLint - Code quality tool
• Prettier - Code formatter
• Workbox - PWA tooling

License

[Add license information here]