Skip to content

Latest commit

 

History

History
138 lines (89 loc) · 6.04 KB

README.md

File metadata and controls

138 lines (89 loc) · 6.04 KB
Raw

FEMR - Fast Electronic Medical Records

Build Status

Scala CI

Description

fEMR is a fast EMR solution for remote clinics who depend on speed and ease of use rather than complex features. Check out Team fEMR's website for more information and a live demo.

Community

  1. Slack
  2. JIRA
  3. Team FEMR

tEMR Community

  1. JIRA

Dependencies

Contributing

For more information on contributing, please see the CONTRIBUTING.md file. For details regarding installation and deployment, continue reading.

CI

This repo uses Github Actions workflows for continuous integration, which can be found under the Actions tab in Github (https://github.com/CPSECapstone/zzs-femr/actions?query=workflow%3A%22Scala+CI%22). The Scala CI workflow runs 'sbt test' whenever code is pushed or a pull request is made to the main branch.

Setting up weekly backup reminder

  • It is very important for the administrator to backup local data to the remote database.
  • A cronjob can be set up before a kit is deployed to automatically display a message once a week.
  1. In the command line, type crontab -e
  2. A text editor should appear.
  3. Add the following line to this file: 0 11 * * 5 /util/WeeklyReminder.sh
  4. This will display a reminder pop up at 11:00AM every Friday.

Warnings

  • fEMR is not HIPAA compliant (... yet).
  • fEMR is not meant to diagnose, treat, cure or prevent disease.
  • fEMR may attempt to establish a secure remote connection when internet access becomes available. This behavior is configurable and turned off by default.

Questions?

Email: [email protected]

Running the application using Docker

  1. Make sure you have Docker installed and running on your machine.
  2. Clone the FEMR/femr repo: git clone https://github.com/FEMR/femr.git
  3. Checkout the super-femr branch: git checkout super-femr.
  4. Cd into the femr directory: cd femr
  5. Run docker-compose up to start the app.
  6. If step 5 successfully finishes, then the app will be available at http://localhost:9000/

Setting up the project with IntelliJ on macOS

Step 1: Download and Install the following Software and Dependencies

Step 2: Clone the repo

  • git clone https://github.com/FEMR/femr.git

Step 3: Setting up the DB

  1. Ensure Docker Desktop is running
  2. Open a terminal at the repository root
  3. Run docker-compose up db to bring up the database. To stop the database use Ctrl+c

Step 4: Configuring IntelliJ

  1. Open IntelliJ IDEA Ultimate. Then open the femr project with super-femr branch checked out.

  2. In IntelliJ IDEA Ultimate and go to Preferences -> Plugins -> click Marketplace -> Then download Scala and Play Framework. Then restart the IDE.

  3. Inside femr/conf folder, create a new file named application.dev.conf.

include "application.conf"
settings.researchOnly=0
db.default.url="jdbc:mysql://127.0.0.1:3306/femr_db?characterEncoding=UTF-8&useSSL=false&allowPublicKeyRetrieval=true"
db.default.username="femr"
db.default.password="password"
photos.defaultProfilePhoto="./public/img/defaultProfile.png"
csv.path="./Upload/CSV"

  1. Go to Run -> Edit Configurations -> click on the + sign -> Play 2 App.

    • If Play 2 App doesn't appear, try restarting the IDE.

  2. In the JVM options of the configuration add -Dconfig.resource=application.dev.conf to the end.

  3. Go to File -> Project structure -> Under the Project tab -> Select Project SDK and set it to 1.8.

    • You can download 1.8 directly from IntelliJ. If so, choose 1.8 Amazon Correto.
screenshot

Image

  1. Change the language level to 8.
screenshot

Image

  1. On the rightmost side of IntelliJ, if there is a vertical line containing sbt. Click on the sbt tab and then click the refresh symbol.
    • If there isn’t sbt on the right, remove the .idea folder from the root directory of the project. In the command line, traverse to the root directory and do: rm -r .idea. Then redo step 2 and then continue. If still does not work try invaliadating IntelliJ's cache.
screenshot

Image

  1. After that runs, click on the Play button to run the configuration. If everything was set up correctly, the website should open up on another window. Select “Apply this script now”.
screenshot

Image

Troubleshooting

  1. Try deleting the .idea folder and rerunning sbt
  2. Confirm you have the absolute path in your environment variables
  3. Try to re-apply the plugins Scala and Play Framework
  4. Otherwise, try cloning the femr github and going through the steps once more.
  5. Try invalidating Intellij IDEA cache.

EULA and Privacy Policy