Skip to content

Commit

Permalink
easy dev doc update (openemr#3685)
Browse files Browse the repository at this point in the history
  • Loading branch information
bradymiller committed Jun 28, 2020
1 parent cfa9552 commit b9f1ee6
Showing 1 changed file with 27 additions and 4 deletions.
31 changes: 27 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,30 @@ You will need a "local" version of OpenEMR to make changes to the source code. T
```sh
docker exec -i $(docker ps | grep _openemr | cut -f 1 -d " ") sh -c '/root/devtools list-snapshots'
```
12. Developer tools to turn on and turn off support for multisite feature.
12. Developer tools to send/receive snapshots (via capsules) that are created above in item 11.
- Here is how to grab a capsule from the docker, which can then store or share with friends.
- List the capsules:
```sh
docker exec -i $(docker ps | grep _openemr | cut -f 1 -d " ") sh -c '/root/devtools list-capsules'
```
- Copy the capsule from the docker to your current directory (using `example.tgz` below):
```sh
docker cp $(docker ps | grep _openemr | cut -f 1 -d " "):/snapshots/example.tgz .
```
- Here is how to send a capsule into the docker.
- Copy the capsule from current directory into the docker (using `example.tgz` below):
```sh
docker cp example.tgz $(docker ps | grep _openemr | cut -f 1 -d " "):/snapshots/
```
- Restore from the new shiny snapshot (using `example` below):
```sh
docker exec -i $(docker ps | grep _openemr | cut -f 1 -d " ") sh -c '/root/devtools restore example'
```
- Ensure run upgrade to ensure will work with current version OpenEMR:
```sh
docker exec -i $(docker ps | grep _openemr | cut -f 1 -d " ") sh -c '/root/devtools upgrade 5.0.2'
```
13. Developer tools to turn on and turn off support for multisite feature.
- Turn on support for multisite:
```sh
docker exec -i $(docker ps | grep _openemr | cut -f 1 -d " ") sh -c '/root/devtools enable-multisite'
Expand All @@ -131,17 +154,17 @@ You will need a "local" version of OpenEMR to make changes to the source code. T
```sh
docker exec -i $(docker ps | grep _openemr | cut -f 1 -d " ") sh -c '/root/devtools disable-multisite'
```
13. Xdebug and profiling is also supported for PHPStorm.
14. Xdebug and profiling is also supported for PHPStorm.
- Firefox install xdebug helper add on (configure for PHPSTORM)
- PHPStorm Settings->Language & Frameworks->PHP->Debug
- Start listening
- Untoggle "Break at first line in PHP scripts"
- Untoggle both settings that start with "Force Break at first line..."
- Make sure port 9000 is open on your host operating system
- Profiling output can be found in /tmp directory in the docker
14. When you're done, it's best to clean up after yourself with `docker-compose down -v`
15. When you're done, it's best to clean up after yourself with `docker-compose down -v`
- If you don't want to build from scratch every time, just use `docker-compose down` so your next `docker-compose up` will use the cached volumes.
15. [Submit a PR](https://github.com/openemr/openemr/compare) from your fork into `openemr/openemr#master`!
16. [Submit a PR](https://github.com/openemr/openemr/compare) from your fork into `openemr/openemr#master`!

We look forward to your contribution...

Expand Down

0 comments on commit b9f1ee6

Please sign in to comment.