sartography/protocol-builder-mock
1
0
Fork 0
mirror of https://github.com/sartography/protocol-builder-mock.git synced 2025-01-12 08:44:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

README updates

Browse Source
This commit is contained in:
Dan 2021-01-20 11:03:14 -05:00
parent e6c2f5a628
commit a8a7061abc
1 changed files with 19 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -7,13 +7,31 @@
* pip (for python 3)
* pipenv (just run pip install pipenv)
## Running these examples
## Database Setup
The database for the CR Connect project will create an empty database for protocol builder as well.
We did this because you would only by running this mock in order to support the app. Would be good
to have this set up and run as a part of that docker-compose rather than having to spin this up seperately.
With the database running, be sure to execute
```
flask db upgrade
```
to set up the database structure.
## Starting up Protocol Builder
```bash
pipenv run python run.py
```
This will start a webserver on localhost at port 5001. To see the api, you can visit
http://localhost:5001/pb/ui
## Create an example study
Finally, you will need to connect to the protocol builder mock ui in a web browser (see above url)
And use this to connect to create a new study. Be sure the study is owned by the person you are logging in
to on CR-Connect. For must development environments this will be dhf8r.
## For future reference, these are the steps Sartography is taking to set up Mock Services: