The Hikma Health platform is a mobile electronic health record system designed for organizations working in low-resource settings to collect and access patient health information. The repository contains the admin web application which is a portal for management of the clinic, its users and patients. Additional functionality can also be added easily.

The platform is designed to be intuitive and allow for efficient patient workflows for patient registration, data entry, and data download. You can see a user demo here: https://drive.google.com/file/d/1ssBdEPShWCu3ZXNCXnoodbwWgqlTncJb/view?usp=drive_link

This repository contains the client-side code for Hikma Health's administrators application. The corresponding server-side code is located at https://github.com/hikmahealth/hikma-health-backend. Please feel free to file feature requests and bugs at either location.

The admin app is a web only application.

Clone the project

  git clone [email protected]:hikmahealth/hikma-health-admin.git

Go to the project directory

  cd hikma-health-admin

Install dependencies

  npm install

Start the frontend

  npm run dev

This will be available on your browser: localhost:3000/

To connect to your backend, either locally hosted or remotely hosted, make sure the backend and database are running. See documentation on server set up here: https://github.com/hikmahealth/hikma-health-backend.

See below for how to tell your frontend where to find your bakend.

To run this project, you will need to add the following environment variable to your .env file

NEXT_PUBLIC_HIKMA_API

This variable holds a link to the backend (server) which connects to the database.This file is by default already ignored in the .gitignore file, make sure it remains there.

🔥 DO NOT COMMIT THIS INFORMATION TO YOUR VERSION CONTROL (GITHUB) OR SHARE IT WITH UNAUTHORIZED PERSONEL 🔥

• React (v18.2): Leading UI library for modern UIs
• NextJS (v13.2): Performant react metaframework with routing and SSR
• Axios (v1.3): HTTP library for easy requests to server
• Twind (v0.16): Tailwind compile library to add minimal styles
• Mantine (v6): UI Component library
• Typescript (v4.8): Adding type support to JavaScript

• Custom form creation through a visual form builder
• Premade template forms with one-click install
• Clinician / User registration and management
• Export patient information (data dump as a spreadsheet)
• Patient information view
• Light/dark mode support

Features on the roadmap represent the vision for the admin portal over the coming versions, but none are guaranteed. If there is a feature you would love to see supported, open a feature-request / issue with more details and we can prioritize features with the most requests.

• Improve data caching - maybe react-query / rtk-query??
• Improve test coverage
• Add support for patient workflows through the admin portal
• Add support for single patient report download
• Refactor form builder code with cleaner types and stable drag and drop
• Support patient search
• Support pagination in patient view
• Improve documentation
• Improve deployment button documentation

MIT