SPICE Product Docs
SPICE 1.0 Docs
SPICE 1.0 Docs
  • Overview
    • 📒What is SPICE?
    • ✨SPICE App Workflows
      • Screening
      • Enrollment
      • Assessment
      • My Patients
      • Medical Review
      • Pharmacy
      • Admin Portal
    • 👩‍⚕️SPICE Users
    • 🔏Data Privacy & Security
      • Privacy Policy
      • Terms & Conditions of Use
    • ❓Frequently Asked Questions (FAQs)
  • Engineering
    • 🖥️Architecture
      • C4 Diagrams
      • FHIR & Standards
    • 🔧Technology Stack
    • 👨‍💻API Documentation
      • Common Services
        • Account Create
        • Change Password for Site Users
        • Country Create
        • Forgot Password
        • Get User Details
        • Get User Profile
        • Locked Users List
        • Login
        • Logout
        • Operating Unit Create
        • Reset Password
        • Set Password for New User
        • Site Create
        • Unlock User
        • User Profile Update
        • Validate User Email
        • Verify Set Password
        • Super Admin
          • Superadmin Details
          • Superadmin List
          • Superadmin Create
          • Superadmin Delete
          • Superadmin Update
      • Admin Services
        • Account
          • Account - Activate
          • Account - Deactivate
          • Account - Deactivated list
          • Account - Details
          • Account - Update
          • Account Admin - Create
          • Account Admin - Delete
          • Account Admin - Update
          • Account Dashboard - Region Admin
          • Account List - Admin
        • Clinical Workflow
          • Create
          • Delete
          • List
          • Update
          • Account Customization - Create
          • Account Customization - Details
          • Account Customization - Update
        • Country Dashboard - Superadmin
        • Lab Test
          • Create
          • Delete
          • Details
          • List
          • Update
          • Lab Test Range - Create
          • Lab Test Range - Delete
          • Lab Test Range - Details
          • Lab Test Range - Update
        • Medication
          • Create
          • Delete
          • Medication Validation
          • List
          • Update
        • Operating Unit
          • Operating Unit - Details
          • Operating Unit - Update
          • Operating Unit Admin - Create
          • Operating Unit Admin - Remove
          • Operating Unit Admin - Update
          • Operating Unit Dashboard - Account Admin
          • Operating Unit List - Admin
        • Program
          • Create
          • List
          • Delete
          • Details
          • Update
        • Region Admin
          • Region Admin - Create
          • Region admin - Delete
          • Region Admin - Details
          • Region admin - Update
        • Site
          • Site - Details
          • Site - Update
          • Site Dashboard - Operating Unit Admin
          • Site List - Admin
          • Site User - Create
          • Site User - Remove
          • Site User - Update
        • Site List - Region Admin
      • SPICE Services
        • Advance-search
        • Advanced search - Site
        • App Version
        • Assessment
        • Assessment Bplog Create
        • Assessment Glucose log Create
        • BPLog List
        • BPLog Create
        • Confirm Diagnosis
        • Device Details
        • Fill Prescription - Update
        • GlucoseLog Create
        • GlucoseLog List
        • Investigation Create
          • Fill Prescription List
        • Investigation List
        • Investigation Search
        • Labtest Result Create
        • Labtest Result Details
        • Labtest Result List
        • Lifestyle Create
        • Lifestyle List
        • Lifestyle remove
        • Lifestyle Update
        • Lifestyle Update view Status
        • Lifestyle view history
        • Medical Review Create - Continuous Medical Review
        • Medical Review Create - Initial Medical Review
        • Medical Review Static Data
        • Medical Review Count
        • Medical review list
        • Medical Review Summary
        • Mental Health Create
        • Mental Health Details
        • Mobile - Forgot Password
        • Mobile - Login
        • Mobile - Logout
        • Nutritionist Lifestyle Create
        • Patient Basic Details
        • Patient Details
        • Patient enrollment
        • Patient-labtest-list
        • Patient Labtest - Remove
        • Patient Labtest - Review
        • Patient-lifestyle-details
        • Patient list
        • Patient Pregnancy Details
        • Patient Pregnancy Details Create
        • Patient Remove
        • Patient Transfer - Create
        • Patient Transfer Count
        • Patient Transfer - Country Site List
        • Patient Transfer - Role user list
        • Patient Transfer List
        • Patient Transfer - Update
        • Patient Transfer - Validate
        • Patient update
        • Patient Visit
        • PatientVisit
        • Pregnancy Create
        • Pregnancy Details
        • Prescription History List
        • Prescription List
        • Prescription Remove
        • Prescription search
        • Pregnancy Update
        • Prescription-history list
        • Prescription Update
        • Refill Prescription History
        • Screening
        • Screening log details
        • Search
        • Transfer Notification Count
        • Treatment Plan Details
        • Treatment Plan Update
        • User Validate API
      • FHIR-Adapter Services
        • Add User
        • Get User By Id
        • Get User By Username
        • Get User List
        • Get User Profile
        • Update User
        • Reset User Password
        • Delete User by ID
        • Forgot Password Validation
        • Options
        • Receive Message
        • Login
        • Site Migration
        • User Migration
        • APIKey Manager API
          • Retrieve API Keys
          • Generate API Keys
          • Delete API Keys
          • Validate API Key
  • Deploy
    • 🚀Deployment Guide
      • 🗄️Server
      • 📱Android
      • 🖥️Admin Portal
      • 🗄️FHIR Adapter
    • 🌎Customization Guide
      • Multi-Language Translation
        • Support for multiple languages
      • Clinical Workflow Customization
      • WHO Hearts Algorithm
      • Country Level Administrative Divisions
  • PRODUCT
    • 🥘Releases
    • 🛣️Roadmap
  • COMMUNITY
    • 🧑‍💻Engage
    • 📞Support
    • 📃Policies
  • LINKS
    • Source Code (GitHub)
    • Medtronic LABS
    • Developer Support
  • versions
    • SPICE 1.0
      • OVERVIEW
        • 📒What is SPICE?
        • ✨SPICE App Workflows
          • Screening
          • Enrollment
          • Assessment
          • Medical Review
            • Treatment Plan
            • Prescribe
            • Lab Test
          • My Patients
          • Pharmacy
          • Admin Portal
        • 👩‍⚕️SPICE Users
        • 🔏Data Privacy & Security
          • Privacy Policy
          • Terms & Conditions of Use
        • ❓Frequently Asked Questions (FAQs)
      • ENGINEERING
        • 🖥️Architecture
          • C4 Diagrams
          • FHIR & Standards
        • 🔧Technology Stack
        • 👨‍💻API Documentation
          • Common Services
            • Account Create
            • Change Password for Site Users
            • Country Create
            • Forgot Password
            • Get User Details
            • Get User Profile
            • Locked Users List
            • Login
            • Logout
            • Operating Unit Create
            • Reset Password
            • Set Password for New User
            • Site Create
            • Unlock User
            • User Profile Update
            • Validate User Email
            • Verify Set Password
            • Super Admin
              • Superadmin Details
              • Superadmin List
              • Superadmin Create
              • Superadmin Delete
              • Superadmin Update
          • Admin Services
            • Account
              • Account - Activate
              • Account - Deactivate
              • Account - Deactivated list
              • Account - Details
              • Account - Update
              • Account Admin - Create
              • Account Admin - Delete
              • Account Admin - Update
              • Account Dashboard - Region Admin
              • Account List - Admin
            • Clinical Workflow
              • Create
              • Delete
              • List
              • Update
              • Account Customization - Create
              • Account Customization - Details
              • Account Customization - Update
            • Country Dashboard - Superadmin
            • Lab Test
              • Create
              • Delete
              • Details
              • List
              • Update
              • Lab Test Range - Create
              • Lab Test Range - Delete
              • Lab Test Range - Details
              • Lab Test Range - Update
            • Medication
              • Create
              • Delete
              • Medication Validation
              • List
              • Update
            • Operating Unit
              • Operating Unit - Details
              • Operating Unit - Update
              • Operating Unit Admin - Create
              • Operating Unit Admin - Remove
              • Operating Unit Admin - Update
              • Operating Unit Dashboard - Account Admin
              • Operating Unit List - Admin
            • Program
              • Create
              • List
              • Delete
              • Details
              • Update
            • Region Admin
              • Region Admin - Create
              • Region admin - Delete
              • Region Admin - Details
              • Region admin - Update
            • Site
              • Site - Details
              • Site - Update
              • Site Dashboard - Operating Unit Admin
              • Site List - Admin
              • Site User - Create
              • Site User - Remove
              • Site User - Update
            • Site List - Region Admin
          • SPICE Services
            • Advance-search
            • Advanced search - Site
            • App Version
            • Assessment
            • Assessment Bplog Create
            • Assessment Glucose log Create
            • BPLog List
            • BPLog Create
            • Confirm Diagnosis
            • Device Details
            • Fill Prescription - Update
            • GlucoseLog Create
            • GlucoseLog List
            • Investigation Create
              • Fill Prescription List
            • Investigation List
            • Investigation Search
            • Labtest Result Create
            • Labtest Result Details
            • Labtest Result List
            • Lifestyle Create
            • Lifestyle List
            • Lifestyle remove
            • Lifestyle Update
            • Lifestyle Update view Status
            • Lifestyle view history
            • Medical Review Create - Continuous Medical Review
            • Medical Review Create - Initial Medical Review
            • Medical Review Static Data
            • Medical Review Count
            • Medical review list
            • Medical Review Summary
            • Mental Health Create
            • Mental Health Details
            • Mobile - Forgot Password
            • Mobile - Login
            • Mobile - Logout
            • Nutritionist Lifestyle Create
            • Patient Basic Details
            • Patient Details
            • Patient enrollment
            • Patient-labtest-list
            • Patient Labtest - Remove
            • Patient Labtest - Review
            • Patient-lifestyle-details
            • Patient list
            • Patient Pregnancy Details
            • Patient Pregnancy Details Create
            • Patient Remove
            • Patient Transfer - Create
            • Patient Transfer Count
            • Patient Transfer - Country Site List
            • Patient Transfer - Role user list
            • Patient Transfer List
            • Patient Transfer - Update
            • Patient Transfer - Validate
            • Patient update
            • Patient Visit
            • PatientVisit
            • Pregnancy Create
            • Pregnancy Details
            • Prescription History List
            • Prescription List
            • Prescription Remove
            • Prescription search
            • Pregnancy Update
            • Prescription-history list
            • Prescription Update
            • Refill Prescription History
            • Screening
            • Screening log details
            • Search
            • Transfer Notification Count
            • Treatment Plan Details
            • Treatment Plan Update
            • User Validate API
          • FHIR-Adapter Services
            • Add User
            • Get User By Id
            • Get User By Username
            • Get User List
            • Get User Profile
            • Update User
            • Reset User Password
            • Delete User by ID
            • Forgot Password Validation
            • Options
            • Receive Message
            • Login
            • Site Migration
            • User Migration
            • APIKey Manager API
              • Retrieve API Keys
              • Generate API Keys
              • Delete API Keys
              • Validate API Key
      • DEPLOY
        • 🚀Deployment Guide
          • 🗄️Server
          • 📱Android
          • 🖥️Admin Portal
          • 🗄️FHIR Adapter
        • 🌎Customization Guide
          • Multi-Language Translation
            • Support for multiple languages
          • Clinical Workflow Customization
          • WHO Hearts Algorithm
          • Country Level Administrative Divisions
      • PRODUCT
        • 🥘Releases
        • 🛣️Roadmap
      • LINKS
        • Source Code (GitHub)
        • Medtronic LABS
        • Developer Support
Powered by GitBook

@2024 Medtronic LABS

On this page
  • Tech stack
  • Setup
  • Configuration
  • .env
  • .env description
  • Sonarqube
  • Install and Running the application in local
  • Testing the application
  • Deployment
  1. versions
  2. SPICE 1.0
  3. DEPLOY
  4. Deployment Guide

Admin Portal

PreviousAndroidNextFHIR Adapter

Last updated 1 year ago

This is the client side for the Spice application to help track hypertensive and diabetic patients across a population.

Tech stack

  • HTML

  • SCSS

  • TypeScript

  • React(17.x.x)

  • Redux

Setup

To bring the Spice client side up and running, there are few prerequisites that have to be followed.

  • Install NodeJS v16.x.x. .

  • Install npm package.

npm install -g npm@8

Clone the spice-opensource repository.

git clone https://github.com/Medtronic-LABS/spice-admin-web.git

Configuration

To run the application, The following properties are to be configured. To achieve this, rename env.example file to .env for the following properties.

REACT_APP_BASE_URL=http://localhost:8762/
REACT_APP_PASSWORD_HASH_KEY=spice_opensource
REACT_APP_CRYPTR_SECRET_KEY=spice_opensource
REACT_APP_GA_TRACKING_ID=2hb78n0
REACT_APP_ORG_SUCCESS_DELAY_TIME=545678
/spice-opensource/spice-admin-web/

.env

The .env file is used to store environment variables for the project. These variables are used to configure the application and contain sensitive information such as passwords, API keys, and other credentials.

Please note that the .env file should never be committed to version control, as it contains sensitive information that should not be shared publicly. Instead, you should add the .env file to your .gitignore file to ensure that it is not accidentally committed.

To use the application, you will need to create a .env file in the root directory of the project and add the necessary environment variables. You can refer to the above file for an example of the required variables and their format.

The values provided in the instructions are for demonstration purposes only and will not work as-is. You will need to replace them with actual values that are specific to your environment.

.env description

REACT_APP_VERSION: This variable could be used to specify the current version of the application.

REACT_APP_BASE_URL: This variable could be used to specify the base URL of the API that the application is consuming.

REACT_APP_PASSWORD_HASH_KEY: This variable could be used to store the password hash key that is used to hash passwords.

REACT_APP_CRYPTR_SECRET_KEY: This variable could be used to store the secret key used for encryption and decryption in the application.

REACT_APP_ORG_SUCCESS_DELAY_TIME: This variable could be used to specify the time delay for success messages displayed to the user.

REACT_APP_GA_TRACKING_ID: This variable could be used to specify the Google Analytics tracking ID for the application to track user behavior and activity.

Sonarqube

Install and Running the application in local

  • Open to exact path.

/spice-opensource/spice-admin-web/
  • Install Dependencies.

npm install

Node modules will be created based on the package.json after running this command.

  • Start Application.

npm start

Testing the application

npm run test

Launches the test runner in the interactive watch mode. See the section about running tests for more information.

Deployment

npm run build

Builds the app for production to the build folder. It correctly bundles React in production mode and optimizes the build for the best performance.

The app build is minified and includes hashed filenames. Deployment is now ready. Use the following credentials to access:

Username: superuser@test.com
Password: Spice123

The application has cleared sonarqube checkpoints. If you'd like to run the analysis, please install Sonarqube

Runs the app in the development mode. Open to view it in the browser.

://: # (These are reference links used in the body of this note and get stripped out when the markdown processor does its job. There is no need to format nicely because it shouldn't be seen. Thanks SO - http://stackoverflow.com/questions/4823468/store-comments-in-markdown-syntax)

🚀
🖥️
Click here
Click here
http://localhost:3000
Git Official site
https://git-scm.com/book/en/v2/Getting-Started-Installing-Git