{"id":18407226,"url":"https://github.com/octri/redcap-report-counts","last_synced_at":"2025-04-07T08:32:36.426Z","repository":{"id":37952611,"uuid":"146941303","full_name":"OCTRI/redcap-report-counts","owner":"OCTRI","description":"A REDCap external module for generating consort reports.","archived":true,"fork":false,"pushed_at":"2024-11-07T22:16:54.000Z","size":3014,"stargazers_count":3,"open_issues_count":3,"forks_count":0,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-17T00:41:59.657Z","etag":null,"topics":["redcap","redcap-external-module","report-counts"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OCTRI.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-08-31T20:52:57.000Z","updated_at":"2024-11-07T23:20:53.000Z","dependencies_parsed_at":"2023-02-18T11:04:44.259Z","dependency_job_id":"2f10ffc0-4423-4250-9563-2b26996630ea","html_url":"https://github.com/OCTRI/redcap-report-counts","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OCTRI%2Fredcap-report-counts","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OCTRI%2Fredcap-report-counts/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OCTRI%2Fredcap-report-counts/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OCTRI%2Fredcap-report-counts/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OCTRI","download_url":"https://codeload.github.com/OCTRI/redcap-report-counts/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247620582,"owners_count":20968234,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["redcap","redcap-external-module","report-counts"],"created_at":"2024-11-06T03:13:07.008Z","updated_at":"2025-04-07T08:32:35.843Z","avatar_url":"https://github.com/OCTRI.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# REDCap Report Counts External Module\n\nA REDCap external module for generating report counts.\n\n## Install Dependencies\n\n```\nnpm install\n```\n\n## Run Unit Tests\n\nJavaScript tests,\n\n```\nnpm test\n```\n\nPHP tests\n\n```\ncomposer test\n```\n\n## Build Application\n\nCompilation is output into the `dist` directory.\n\n```\nnpm run build\n```\n\n## Start Application for Local Development\n\nTo continuously build the application as you develop, run,\n\n```\nnpm run start\n```\n\n## Install the module\n\n### Module directory format\n\nExternal modules live in the `modules` directory under the REDCap root directory. After building the project copy the `dist` directory there and rename it as follows,\n\n```\nredcap/modules/report_counts_vx.y.z\n```\n\nwhere `report_counts` is the module prefix, and `x.y.z` is the version.\n\n#### Running under Docker\n\nIf you are running REDCap under Docker, you may want to bind mount the `dist` directory. For example,\n\n```\nvolumes:\n  - /path/to/report-counts/dist:/var/www/html/redcap/modules/report_counts_v0.0.0\n```\n\nNow changes are published instantly when running `npm run start`.\n\n### Module URLs\n\nIn code, you may generate a page URL using the following syntax where `$module` is provided automatically. This will produce the index URL above.\n\n```\n$indexUrl = $module-\u003egetUrl('index');\n```\n\nThe URL will look something like the following,\n\nhttp://localhost/redcap/external_modules/?prefix=report_counts\u0026id=5\u0026page=index\u0026pid=782\n\nwith these parameters: `prefix`, `id`, `page`, and `pid`.\n\n`prefix` is the module prefix as described previously.\n\n`id` is the module id and is appended automatically when using the module functions, such as `getUrl()`.\n\n`page` corresponds to the PHP file. For example, `page=index` will pull up `index.php`. Including the `.php` extension is optional.\n\n`pid` is the project id.\n\n### Enabling the module\n\nOnce your module directory is in place we need to tell REDCap about it.\n\n1. Navigate to *Control Center \u003e External Modules*.\n2. Click *Enable a module*.\n3. You should see report counts with a version drop-down. Select the version you want to enable and click *Enable*.\n4. Next go to your project and on the left navigation bar click *External Modules*.\n5. Click *Enable a module* and find the report counts module.\n6. Click *Enable* to enable for your project.\n\nNow you should see a link under the \"External Modules\" section on the left navigation bar.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foctri%2Fredcap-report-counts","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foctri%2Fredcap-report-counts","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foctri%2Fredcap-report-counts/lists"}