Pain Reporting Portal

About

The pain reporting portal is de-identified patient and survey management system. It allows clinicians to schedule digital surveys to be delivered to patients. As well as allowing clinicians to monitor patient responses to look for possible interventions.

Installation Instructions

1. install Git
2. install Node JS
3. install MySql
4. optionally install Node Gyp dependencies (strongly recommended)
5. clone git repository git clone https://github.com/promisasu/Portal
6. open the folder cd Portal
7. run npm install

Setup Instructions

1. The portal uses the same database as the CNMC PROMIS Application. Please ensure that you have the correct and latest schema. You can find the schema with some sample data in the database folder of this repository. For full dump, please contact the developers or refer to the dropbox.
2. run npm run init
3. run npm run user. This command sets up the user who gains access to the portal once it's deployed.
4. Connect to the local MySQL server and run the command set GLOBAL sql_mode="";

Start the Portal

1. run npm run start

Debug the Portal

• run npm run status to view status of all servers
• run npm run log to view server logs

Test the Portal

1. run npm run lint
2. run npm run test

View Code Documentation

1. run npm run documentation
2. open the documentation folder in a file explorer
3. open index.html in a browser

Additional Guides

• Contributing
• Design
• Issue Template
• Pull Request Template

Tasks

Tasks can be run by calling npm run <task>

• check detect outdated or insecure packages
• documentation generate code documentation
• init create a server configuration file
• lint lint check project files
• lint-fix auto fixes some lint errors
• log view server logs
• start start all services
• start-dashboard start dashboard service
• start-scheduler start scheduler service
• status check service statuses
• stop stop all services
• stop-dashboard stop dashboard service
• stop-scheduler stop scheduler service
• sync synchronize database schema
• test run the test suite
• user create a new user
• validate detect invalid server configuration