@researchdatabox/sails-hook-redbox-redcap
v1.0.0
Published
Redbox hook for REDCap API
Downloads
116
Maintainers
Readme
A Sails Hook Redbox - REDCap
In this example template you will find the barebones requirements for a Hook
This Project is divided between folders
api
Main API of your Hook can be stored in controllers and services
- controllers
- services
config & form-config
This configurations are redbox-portal dependent. They will allow redbox to be available as a record If you require to have a form in your portal
config/recordtype
config/workflow
form-config/template-1.0-draft
- `config/env/development.js
redcap: {
parentRecord: 'rdmp',
formName: 'redcap-1.0-draft',
workflowStage: 'draft',
appName: 'redcap',
appId: 'redcap',
recordType: 'redcap',
location: 'https://redcap.research.uts.edu.au',
description: 'REDCap Workspace'
}
index
Main entry point for the hook
initialize
Init code before it gets hooked.
routes
Controller routes exposed to the sails front-end
'get /your/route' : YourController.method
configure
Add configuration and services to your sails app
sails.services['YourService'] = function() { };
sails.config = _.merge(sails.config, {object});
test
First run npm install
Test your sails hook with mocha by running npm test
before adding the hook to your redbox-portal.
It may cause your application to not lift.
$ npm test
> @uts-eresearch/[email protected] test /Users/moises/source/code.research/sails-hook-redbox-template
> NODE_ENV=test node_modules/.bin/mocha
Basic tests ::
✓ should have a service
✓ should have a form
✓ should have a route
✓ sails does not crash
4 passing (864ms)
For more information on testing your hook go to : https://sailsjs.com/documentation/concepts/testing
Development in redbox-portal
A docker-compose.yml file is present in support/development and is setup to run the full ReDBox stack and install the hook. To run the stack there is a ReDBox Sails Hook Run Utility in the root of the project
Usage
ReDBox Sails Hook Run Utility
Usage: ./runForDev.sh [-a|--(no-)angular] [-h|--help]
-a,--angular,--no-angular: Angular mode. Will ensure permissions are set correctly on the Sails working directory so that changes can be applied (off by default)
-h,--help: Prints help
Note: The first time the stack runs it may take some time as yarn initialises the hook within ReDBox Portal. All subsequent runs should be faster