{"id":21982091,"url":"https://github.com/lhncbc/lforms","last_synced_at":"2025-04-14T05:18:06.132Z","repository":{"id":22271494,"uuid":"25605743","full_name":"LHNCBC/lforms","owner":"LHNCBC","description":"See the project website at http://lhncbc.github.io/lforms/, or view the demo website at https://lhcforms.nlm.nih.gov/lhcforms.","archived":false,"fork":false,"pushed_at":"2025-04-03T20:14:00.000Z","size":19664,"stargazers_count":110,"open_issues_count":37,"forks_count":60,"subscribers_count":23,"default_branch":"master","last_synced_at":"2025-04-07T00:13:15.308Z","etag":null,"topics":["fhir","javascript"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/LHNCBC.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","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":"2014-10-22T21:39:35.000Z","updated_at":"2025-04-03T20:14:04.000Z","dependencies_parsed_at":"2023-09-26T21:51:31.861Z","dependency_job_id":"3888cb0a-0c80-4049-9cc0-e42cfe79575a","html_url":"https://github.com/LHNCBC/lforms","commit_stats":{"total_commits":2121,"total_committers":13,"mean_commits":"163.15384615384616","dds":0.6049033474776049,"last_synced_commit":"18ccfa192d8733a00f2467cd44efc2c9a1ef9203"},"previous_names":["nlm-lhc/lforms","lhncbc/lforms"],"tags_count":369,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LHNCBC%2Flforms","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LHNCBC%2Flforms/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LHNCBC%2Flforms/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LHNCBC%2Flforms/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LHNCBC","download_url":"https://codeload.github.com/LHNCBC/lforms/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248824694,"owners_count":21167345,"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":["fhir","javascript"],"created_at":"2024-11-29T17:21:50.211Z","updated_at":"2025-04-14T05:18:06.111Z","avatar_url":"https://github.com/LHNCBC.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## What is LForms?\n\n[LForms](http://lhncbc.github.io/lforms/), a.k.a. LHC-Forms, is a feature-rich,\nopen-source Web Component that creates input forms, based on definition files, \nfor Web-based applications. In addition to its native form-definition format, \nit partially supports the HL7 FHIR Questionnaire standard (SDC profile), and work\nis in progress to expand that support.\n\nIt is being developed by the Lister Hill National Center for Biomedical\nCommunications ([LHNCBC](https://lhncbc.nlm.nih.gov)), National Library of\nMedicine ([NLM](https://www.nlm.nih.gov)), part of the National Institutes of\nHealth ([NIH](https://www.nih.gov)), with the collaboration and support from \nthe [Regenstrief Institute](https://www.regenstrief.org/), Inc. and the\n[LOINC](https://loinc.org/) Committee.\n\nFor features and demos, please visit the [project\npage](http://lhncbc.github.io/lforms/).\n\n## Licensing and Copyright Notice\n\nSee [LICENSE.md](LICENSE.md).\n\n## Customizing and Contributing\n\nIf you wish to revise this package, the following steps will allow you to make\nchanges and test them:\n\n- Install Node.js (version 14 is what we are currently using, but it should work \n  with later versions)\n- Clone the lforms repository and cd to its directory\n- `source bashrc.lforms` (make sure node dir is available at ~/)\n- `npm ci`\n- `source bashrc.lforms` # to add node_modules/.bin to your path\n- `npm run build` # build both FHIR libs and LHC-Forms web component\n- `npm run start` # starts the app we use for testing\n- `npm run test` # runs the unit tests and e2e tests\n\nIf you are planning to contribute new functionality back to us, please\ncoordinate with us, so that the new code is in the right places, and so that\nyou don't accidentally add something that we are also working on.\n\n## Development server\n\n- Run `npm run start` for a dev server. Navigate to `http://localhost:4200/`.\n  The app will automatically reload if you change any of the source files.\n\n- Run `npm run start-public` if you need to access to the dev server from a \n  different machine. For example, to run Narrator from a Windows PC.\n\n## Build\n\n- Run `npm run build` to build the project and generate a production version of\n  the js files, which are much smaller than the development version. It\n  generates an ES2017 version of the js files under dist/lforms. For details on\n  the files to load, see [\"Usng the LHC-Forms Web Component\"](#using).  \n  The `dist` directory is deleted and recreated during the process.\n\n  The build also concatenates all the js files (except for zone.min.js and the\n  FHIR support files) into a single `lhc-forms.js` file, and it works,\n  but we don't currently recommend their use because the\n  source maps don't work with these files. Also, there is a dist/webcomponent\n  directory that is created with a copy of the files in dist/lforms, but that\n  is only needed for the tests.\n\n## Running tests\n\n1. Run `npm run test` to run unit tests and e2e tests, which also copies the \n   FHIR lib files and built files in places for testing.\n\n## Running unit tests\n\n1. Run `npm run test:unit` to execute the unit tests via \n   [Karma](https://karma-runner.github.io).\n\n## Running end-to-end tests\n\n1. Run `npm run test:e2e` to execute the end-to-end tests via \n   [Cypress](https://www.cypress.io/). The e2e tests are configured to use Chrome.\n\n## \u003ca id=\"using\"\u003eUsing the LHC-Forms Web Component\u003c/a\u003e\n\nThere are several script files to load. If you are building this, these files \nwill be under `dist/lforms`. If you are using the pre-built versions from\nhttps://clinicaltables.nlm.nih.gov/lforms-versions, then the file paths below\nare relative to those versioned directories.\n\n1. `webcomponent/styles.css`\n\nYou need to include the following files in your project:\n\n1. `webcomponent/styles.css`\n2. `webcomponent/assets/lib/zone.min.js` (unless you already have zone.min.js \n   on the page)\n3. `webcomponent/runtime.js`\n4. `webcomponent/polyfills.js`\n5. `webcomponent/main.js`\n6. _One_ of the FHIR support library files, assuming you are planning to use\n   FHIR Questionnaires:\n   - `fhir/lformsFHIRAll.min.js`\n   - `fhir/R5/lformsFHIR.min.js`\n   - `fhir/R4B/lformsFHIR.min.js`\n   - `fhir/R4/lformsFHIR.min.js`\n   - `fhir/STU3/lformsFHIR.min.js`\n\nThere is an example of an app using these files at\nhttps://lhcforms.nlm.nih.gov/lforms-fhir-app/.\nFor details about how to work with this library, and for information about an\nannouncements list, see the [documentation](https://lhncbc.github.io/lforms/).\n\n## \u003ca id=\"npm-package\"\u003elforms npm package\u003c/a\u003e\n\nA complete npm package that you can use with import/require statements in your\ncode is not ready yet. The current lforms npm package only contains built files\nin `/dist/lforms` directory. You can use those files as described in above\nsection [Using the LHC-Forms Web Component](#using).\n\n## \u003ca id=\"docs\"\u003eRelated Documents\u003c/a\u003e\n- `form_definition.md` The internal data format of the LHC-Forms widget.\n- `changed-features.md` The list of features that changes between the new \nversion (v30.0.0) and previous versions.\n- `r4-support.md` The FHIR R4 features supported by LHC-Forms widget. \n- `sdc-support.md` The FHIR SDC features supported by LHC-Forms widget.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flhncbc%2Flforms","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flhncbc%2Flforms","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flhncbc%2Flforms/lists"}