Skip to content
EdEHR
JavaScript Vue CSS Shell HTML Assembly Other
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE
client
database
deployment
docs
makeEhrV2
makeMeds
nginx
server
.gitignore
.prettierrc
CONTRIBUTING.md
LICENSE
LICENSE-addition.txt
README.md
_config.yml
docDeploy.sh
erin-johns-seed.json
issue_template.md
package.json

README.md

Project - EdEHR

Educational Electronic Health Record system: a BCcampus project

Description

EdEHR is an open source tool developed to teach medical students how to use an EHR before they enter the workforce. It can be accessed only through a learning management system (LMS) and requires a technical person to set it up. Once set up, users can access the system either as an instructor or a student. Credentials to try out either role are included below.

Documentation

Public docs are available here https://bccampus.github.io/edehr/

Demo

You can try out a demo of the EdEHR by logging into [Moodle] (https://edehrlms.bccampus.ca/login/index.php) with the following credentials:

Instructor

username
password

Student

username
password

Open Erin Johns - Day 0 Assignment by clicking on it and it will take you directly into the EdEHR

Getting started

Begin by installing an LMS (only Moodle has been tested at this time). Only with an LMS installed can you access the EdEHR locally.

Installation

Git clone the repository

cd /your/development/area
git clone https://github.com/BCcampus/edehr.git

After cloning the repository or to update packages used by the server or client run this one-step install script:

npm run install

Start your development server

Method 1

This method starts the components one at a time. This is best for intensive development where you need to have a close contact with the code and the components.

Start the database server (in docker container)

npm run start:db

Start the API server. From project root:

npm run start:server

In another terminal session start the client. From project root:

npm run start:client

When done stop the database server. From project root:

npm run stop:db

Method 2

This method starts all the components with one script, each in their own docker container.

cd deployment

to build the containers and start attached to see debug logs

npm run dev:build

to run containers that were built in detached mode

npm run dev:run

to stop detached running containers

npm run dev:stop

Run Production

When all changes have been made locally and you wish to update your production server, follow the instructions below.

First build the client vue project.

# in project root
npm run build

Starts all the components with one script, each in their own docker container.

cd deployment
# to build the containers and start attached to see debug logs
npm run prod:build
# to run containers that were built in detached mode
npm run prod:run
# to stop detached running containers
npm run prod:stop

Lint

Run lint on both the client and server code base. From project root:

npm run lint

Test

Run test on both the client and server code base. From project root:

npm run test

EHR screen generation

There are over 40 EHR screens that are generated using a Google spreadsheet. This spreadsheet generates each screen's form layout, table layout, modal forms and can include option default data to include in the seed.

If you wish to make edits to the screens or the defaut data, copy a version of the spreadsheet to your own Google Drive account (downloading and opening in Excel is not supported) and make the edits there. Copy the data from the furthest right-hand columns into the respective file in the makeEhr directory.

Run the following command:

cd makeEhrV2

Then

./deploy.sh --lint

Pro tip: The --lint option can be replaced with -l.

You must use this lint option before submitting files. If you are making changes to view locally in multiple steps, you can shorten the time it takes to run the command by leaving lint out of the command.

Please remember to run the script with lint when you are done and ready to submit your code.

Contributing

EdEHR is an open source project and we encourage contributions. Please read CONTRIBUTING.md before contributing.

Documentation

For more details about this project, view the documentation

Alternatively, you can run a local documentatiom server by running the following command in your terminal:

npm run docs:dev

Then visit http://localhost:8080/edehr See documentation in the docs directory.

You can’t perform that action at this time.