Skip to content

Commit 7656459

Browse files
author
JAMES FUQIAN
committed
add how to run tests to readme.
1 parent bb92820 commit 7656459

1 file changed

Lines changed: 32 additions & 27 deletions

File tree

README.md

Lines changed: 32 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,26 @@
1-
Create a Blue Button Sandbox Account
2-
---------------
3-
Create an account at the link below, and register your test application, to get your Blue Button Sandbox Credentials which will allow you to
4-
access the Blue Button synthetic data. These credentials will be necessary to run this sample application as well as
5-
utilize the Blue Button data within your own applcation. See the section below 'Running the Back-end & Front-end'.
1+
## Create a Blue Button Sandbox Account
2+
3+
Create an account at the link below, and register your test application, to get your Blue Button Sandbox Credentials which will allow you to
4+
access the Blue Button synthetic data. These credentials will be necessary to run this sample application as well as
5+
utilize the Blue Button data within your own applcation. See the section below 'Running the Back-end & Front-end'.
66

77
https://sandbox.bluebutton.cms.gov/v1/accounts/create
88

9-
To ensure this sample application will work properly, make sure that when you register your application you add
9+
To ensure this sample application will work properly, make sure that when you register your application you add
1010
the following url (see below) under the 'Callback URLS/Redirect Uris' section:
1111

1212
http://localhost:3001/api/bluebutton/callback/
1313

1414
When you are ready to run your own application, you can change this value to the url that you need.
1515
Just log into your Blue Button Sandbox account and select 'View/Edit App->'.
1616

17-
Setup Docker & Node-js
18-
---------------
17+
## Setup Docker & Node-js
1918

20-
Install and setup Docker. Go to https://docs.docker.com/get-started/ and follow the directions.
19+
Install and setup Docker. Go to https://docs.docker.com/get-started/ and follow the directions.
2120

22-
Download and install node. Go to https://nodejs.org/en/download/ and follow the directions.
21+
Download and install node. Go to https://nodejs.org/en/download/ and follow the directions.
2322

24-
Running the Back-end & Front-end
25-
---------------
23+
## Running the Back-end & Front-end
2624

2725
Once you have Docker and Node installed and setup then do the following:
2826

@@ -31,12 +29,11 @@ Once you have Docker and Node installed and setup then do the following:
3129
Make sure to replace the clientId and clientSecret variables within the config file with
3230
the ones you were provided, for your application, when you created your Blue Button Sandbox account.
3331

34-
3532
copy server/src/pre-start/env/sandbox.sample.env -> server/src/pre-start/env/development.env
3633

3734
docker-compose up -d
3835

39-
This single command will create the docker container with all the necessary packages, configuration, and code to
36+
This single command will create the docker container with all the necessary packages, configuration, and code to
4037
run both the front and back ends of this sample application.
4138

4239
To see the application in action open your browser and enter the following URL:
@@ -45,20 +42,19 @@ http://localhost:3000
4542

4643
To see the process of authenticating with Blue Button via Medicare.gov and retrieve EoB data just click on the 'Authorize' button.
4744

48-
BB2 Sandbox User
49-
-----------
50-
To ensure data displays properly in the sample application please use a
51-
Blue Button Sandbox user that has PDE (Part-D Events) EoBs (Explanation of Benefits). An example of a user with this
52-
data would be: BBUser29999 (PWD: PW29999!) or BBUser29998 (PWD: PW29998!)
45+
## BB2 Sandbox User
46+
47+
To ensure data displays properly in the sample application please use a
48+
Blue Button Sandbox user that has PDE (Part-D Events) EoBs (Explanation of Benefits). An example of a user with this
49+
data would be: BBUser29999 (PWD: PW29999!) or BBUser29998 (PWD: PW29998!)
50+
51+
## Development
5352

54-
Development
55-
-----------
5653
Read the DEVELOPER NOTES found in the code to understand the application
57-
and where you will need to make adjustments/changes as well as some
54+
and where you will need to make adjustments/changes as well as some
5855
suggestions for best practices.
5956

60-
Usage Examples
61-
-----------
57+
## Usage Examples
6258

6359
To start the sample in Docker :
6460

@@ -70,7 +66,7 @@ To start the sample in native OS (e.g. Linux) with server and client components
7066
1. go to the base directory of the repo
7167
2. run below to start the server:
7268
1. yarn --cwd server install
73-
2. yarn --cwd server start:dev
69+
2. yarn --cwd server start:dev
7470
3. run below to start the client:
7571
1. yarn --cwd client install
7672
2. yarn --cwd client start-native
@@ -81,6 +77,15 @@ Both ways of starting the sample are running the sample in foreground, logging a
8177

8278
For client and server started separately in their command window, type Ctrl C respectively
8379

84-
Error Responses and handling:
85-
-----------------------------
80+
## Run tests
81+
82+
Go to local repo base directory:
83+
84+
copy server/src/configs/sample.config.ts -> server/src/configs/config.ts
85+
86+
yarn --cwd server install
87+
yarn --cwd server test
88+
89+
## Error Responses and handling:
90+
8691
[See ErrorResponses.md](./ErrorResponses.md)

0 commit comments

Comments
 (0)