search

ctsit / redcap_external_module_development_guide

A resource for REDCap module development for REDCap admins and developers presented at https://ctsit.github.io/redcap_external_module_development_guide/
Other
8 stars 9 forks source link
jekyll redcap

readme

REDCap External Module Development Guide

DOI

The REDCap External Module Development Guide is a guide to the development of software extensions to Vanderbilt University's Research Electronic Data CAPture (REDCap) using REDCap's External Module framework. Added to REDCap in the Fall of 2017, the external module framework has proven to be an effective and popular way to change REDCap's behavior to meet the needs of specific sites and projects. This guide provides an introduction to external modules and guidance in creating a team and plan for developing modules for one's own needs and the broader REDCap community.

This software repository contains the source documents to render the Guide into a website use Jekyll. That web site is accessible at https://ctsit.github.io/redcap_external_module_development_guide/. This repository also contains the coding exercises referenced in the guide.

How is this web site managed?

The web site is rendered via Jekyll, a static website generator. It is based on Github's Minimal Jekyll theme. It's hosted by Github using their GitHub Pages feature. This combination makes for an extremely simple, zero-cost website.

Managing a Jekyll web site requires skills common amongst software developers. If you have that skill set or have a volunteer who does, such a web site is cheap and secure. If you are non-technical, you can learn this too.

Sharing

All of the content for this web site is available under the Creative Commons Attribution-NonCommercial 4.0 International License. See CC BY-NC 4.0 for more details.

Site Development

If you would like to manage this web site, you will need to some software tools on your computer and some technical skills to manage them. This is your 10 cent tour.

Prerequisites

Install these tools on your computer.

Recommended training

You'll be well-served to read the Getting started section of the Jekyll docs. You won't have to create the web site, as one is provided in the GitHub repo, but the concepts described in the tutorial will help you understand what Jekyll will do with the changes you make to the files in the repo and how those will become part of the web site.

Setup

Once the software is installed, clone the git repo at https://github.com/ctsit/redcap_external_module_development_guide. cd into the cloned repo, then cd in the docs folder, and run script/serve.sh. That script will run Jekyll in dev mode, use _config_local.yaml if it exists, and serve the content it creates at localhost:4000.

Access the web site to verify it works before you make any changes.