Skip to content

Commit

Permalink
Update README and CONTRIBUTING
Browse files Browse the repository at this point in the history
updated mysql version to 5.7 and changed play env variable to sbt

add test to initial clean compile test

specify use of absolute filepath

add teamfemr.org to README

add link to website/demo to README

add warning for remote connectivity and add sbt to README instructions
  • Loading branch information
Kevin Zurek committed May 23, 2018
1 parent 7be9409 commit 802c07d
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 13 deletions.
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@
# Installation and Configuration using IntelliJ IDEA:

### Required downloads
1. [MySQL 5.6](http://www.mysql.com/)
1. [MySQL 5.7](http://www.mysql.com/)
2. [Scala Build Tool](http://www.scala-sbt.org/)
3. [Java JDK 1.8](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html)
4. [IntelliJ IDEA Ultimate](http://www.jetbrains.com/idea/)
5. [Git](http://git-scm.com/)

### Installation and Configuration
1. make sure java and play environment variables are set
1. make sure java and sbt environment variables are set

2. fork the repository to your GitHub account

Expand All @@ -23,9 +23,9 @@
git clone https://github.com/yourusername/femr.git
```

4. clean and compile the project
4. clean, compile, and test the project
```bash
sbt clean compile
sbt clean compile test
```

### Setting up IntelliJ IDEA
Expand All @@ -40,7 +40,7 @@
9. If asked to select modules/data, select fEMR(root module) and fEMR-build.
10. Create a file named application.dev.conf in the conf folder, copy and paste the information from application.example.conf in it. Change the information to match your database, username, and password.
11. Create a database in mySQL with the same name as the database in the connection string inside of application.dev.conf
12. Under Run, select Edit configurations. Create a new Play 2.0 application and add the following environment variables:
12. Under Run, select Edit configurations. Create a new Play 2.0 application and add the following environment variables using your absolute filepath to the file:
[config.file // /absolute/location/to/conf/application.dev.conf]
[user.dir // /absolute/location/to/femr]
13. Run
Expand Down
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,14 @@

[![Build Status](https://concourse.teamfemr.org/api/v1/pipelines/femr/jobs/build-test-package/badge)](https://concourse.teamfemr.org/teams/main/pipelines/femr)

A simple and fast EMR system.
### 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](https://teamfemr.org) for more information and a live demo.

### Community
1. [Slack](http://teamfemr.org/slack.html)
2. [JIRA](https://teamfemr.atlassian.net)

### Description

The goal is to become an easy EMR solution for remote clinics who depend on speed and ease of use rather than complex features.
3. [Team FEMR](https://teamfemr.org)

### Dependencies

Expand All @@ -20,7 +19,6 @@ The goal is to become an easy EMR solution for remote clinics who depend on spee

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

Add play framework to your PATH environment variable if you haven't done so already. For more information, visit the official [PlayConsole](https://www.playframework.com/documentation/2.3.x/PlayConsole) page.

#### 1. Edit application.conf accordingly.
#### 2. Enter the console.
Expand All @@ -29,8 +27,9 @@ Add play framework to your PATH environment variable if you haven't done so alre

### Warnings

* This application is not HIPAA compliant (... yet).
* This application is not meant to diagnose, treat, cure or prevent disease.
* 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?

Expand Down

0 comments on commit 802c07d

Please sign in to comment.