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

Write EM Development 101 Class #34

Closed pbchase closed 3 years ago

pbchase commented 4 years ago

Turn the Dev Class doc we have into a self-guided intro into building a REDCap Development environment with a running REDCap, Dev tools, and a tour of REDCap from an Admin's perspective. Construct it so that it is accessible to a REDCap project builder with no development skills, yet allow a developer to skip quickly to the parts germane to them.

Crudely, follow these steps:

  1. Copy https://github.com/ctsit/redcap_external_module_development_guide/blob/master/docs/development_class.md to the rc_em_dev_101.md
  2. Title it "Building a REDCap Development Environment"
  3. Remove chit chat about UAMS
  4. Move content relevant to a workshop to footnotes

Required Resources

  1. Add preamble to Required Resources to say that these are recommended tools. They easiest for the neophyte. If you know what you are doing use whatever you like.
  2. Add git-bash for windows users to downloads.
  3. Add links to recommended IDEs and editors i.e., vim.
  4. Make hotlinks to Firefox and Chrome dev tools docs.
  5. Recommend a sequence to simplify setup for newbies: get github account; git-bash; install github desktop; Configure github desktop for your github account; install your editor; configure github desktop to use your editor, and git-bash; install Docker Desktop

Pre-req Setup Tasks

  1. For Pre-req Setup Tasks: move slack stuff to Footnotes; Delete the rest of the section

REDCap-Specific Setup

  1. Instruct student to install RDC via zip file.
  2. Add images to help students understand what is happening as we instruct them to open a terminal and run commands.
  3. Annotate images with Skitch

Wrap up

  1. Delete everything from "Playtime" down
  2. Direct student to RC EM Dev 102 to take tour through REDCap with Admin rights
pbchase commented 3 years ago

addressed by PR #37