https://github.com/tertek/create-redcap-module

A simple CLI tool to generate new REDCap external modules.
https://github.com/tertek/create-redcap-module

redcap redcap-devtool redcap-external-module

Last synced: about 2 months ago
JSON representation

A simple CLI tool to generate new REDCap external modules.

• Host: GitHub
• URL: https://github.com/tertek/create-redcap-module
• Owner: tertek
• Created: 2021-03-29T15:24:51.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-08-15T09:49:36.000Z (over 1 year ago)
• Last Synced: 2024-07-02T09:19:36.714Z (6 months ago)
• Topics: redcap, redcap-devtool, redcap-external-module
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/create-redcap-module
• Size: 200 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# create-redcap-module

A simple CLI tool to generate new REDCap external modules.

![alt text](/create-redcap-module-carbon.png "Screenshot")

## Requirements

- [Node.js](https://nodejs.org/en/) (developed with v16.20.0, not tested on other versions)

## How to use

Please check the [documentation](https://tertek.github.io/create-redcap-module/) for detailed instructions.

Navigate into your redcap modules folder

```bash

   cd modules

``` 

Run the module generator directly over npx

```bash

   npx create-redcap-module

``` 

After completing the necessary input, a module folder will be available at `/redcap/modules/`.

## Development

Feature and pull requests are welcome.

Running the CLI locally:

1. Clone the repo.

2. Run `node ./path-to-module/bin/create-redcap-module`

(please ensure your node version is set to required version ,see `.nvmrc`)

## Roadmap

- ~~Optimize template generation~~

- Add more features to template(s) (BabelJS, phpunit, composer, ..)

- Add more template variations (Action Tag, API Extension, ..)

- Add help option/explanation to CLI (optionator)

- Automatic npm publishing flow (@release)

## Changelog

Version | Description

------- | --------------------

v1.0.0  | Initial release.

v1.0.1  | Added first features.

v1.1.0  | Rewrite of most parts.

v1.1.1  | Update Readme(s).

v1.1.2  | Fix path building cross platform.

v1.2.0  | Add features through composer: Psalm, PHPUnit and varDump.

v1.3.1  | Upgrade REDCap Framework version, upgrade npm dependecies

v2.0.0  | Update package dependencies, REDCap Framework version, remove psalm task (covered by framework itself)