-
Clone the repository
# with https git clone https://github.com/opensrp/web.git # with ssh git clone [email protected]:opensrp/web.git
-
Cd into the cloned web directory
cd web
-
Create a
.env
file in the main package directory (/app
)-
You can do this by copying the
/app/.env.sample
filecp app/.env.sample app/.env
-
-
Override the created
.env
values to match yourKeycloak
andFHIR server
deployment configurations -
Install dependencies
yarn install
-
Build packages
yarn lerna:prepublish
-
Start the react app
yarn start
-
The app starts and automatically launches itself on your default browser on http://localhost:3000
-
Run the
test
command in the root directory to run all test suites for all packages, or inside a specific package directory to only run the package's test suits.yarn test
-
You can use OAuth 2.0's
Implicit Grant flow
to run the app with direct authentication to Keyckloak. I.e bypassing the express authentication backend.-
This is done by setting the
REACT_APP_BACKEND_ACTIVE
env to falseREACT_APP_BACKEND_ACTIVE=false
-
-
To make a code contribution follow the contributing documentation
-
To see UI changes after making a contribution to a package, cd into the packages' directory and rebuild it using the build command in it's package.json
-
e.g to rebuild the Fhir Group Management package after making code changes to it:
cd packages/fhir-group-management yarn build
-