https://github.com/redbox-mint/sails-hook-redbox-redcap
ReDBox Provisioner plugin for Redcap
https://github.com/redbox-mint/sails-hook-redbox-redcap
Last synced: 5 months ago
JSON representation
ReDBox Provisioner plugin for Redcap
- Host: GitHub
- URL: https://github.com/redbox-mint/sails-hook-redbox-redcap
- Owner: redbox-mint
- Created: 2023-11-14T04:46:48.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-12-05T02:25:51.000Z (over 1 year ago)
- Last Synced: 2025-05-29T20:24:04.071Z (about 1 year ago)
- Language: TypeScript
- Size: 12.1 MB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Support: support/build/compileAngularLegacy.sh
Awesome Lists containing this project
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
```javascript
'get /your/route' : YourController.method
```
### configure
Add configuration and services to your sails app
```javascript
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.
```sh
$ npm test
> @uts-eresearch/sails-hook-redbox-template@1.0.0 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