{"id":23421251,"url":"https://github.com/nhsdigital/ndr_ui","last_synced_at":"2025-06-12T08:34:41.442Z","repository":{"id":1736154,"uuid":"43672187","full_name":"NHSDigital/ndr_ui","owner":"NHSDigital","description":"National Disease Registers standard Rails UI","archived":false,"fork":false,"pushed_at":"2024-05-17T10:30:10.000Z","size":367,"stargazers_count":0,"open_issues_count":10,"forks_count":11,"subscribers_count":16,"default_branch":"main","last_synced_at":"2024-05-17T11:26:56.560Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NHSDigital.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-10-05T08:08:13.000Z","updated_at":"2024-05-20T15:31:02.293Z","dependencies_parsed_at":"2024-05-20T15:30:56.694Z","dependency_job_id":"8f9e1c38-74a3-47d0-89a0-42a9b18058b6","html_url":"https://github.com/NHSDigital/ndr_ui","commit_stats":{"total_commits":227,"total_committers":16,"mean_commits":14.1875,"dds":0.6123348017621145,"last_synced_commit":"293b0f3c3ce76cac9fb6ae061af6c61738eaf243"},"previous_names":[],"tags_count":42,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NHSDigital%2Fndr_ui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NHSDigital%2Fndr_ui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NHSDigital%2Fndr_ui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NHSDigital%2Fndr_ui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NHSDigital","download_url":"https://codeload.github.com/NHSDigital/ndr_ui/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248578863,"owners_count":21127713,"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":[],"created_at":"2024-12-23T02:14:34.428Z","updated_at":"2025-04-12T14:05:45.950Z","avatar_url":"https://github.com/NHSDigital.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# NdrUi [![Build Status](https://github.com/NHSDigital/ndr_ui/workflows/Test/badge.svg)](https://github.com/NHSDigital/ndr_ui/actions?query=workflow%3Atest) [![Gem Version](https://badge.fury.io/rb/ndr_ui.svg)](https://rubygems.org/gems/ndr_ui) [![Documentation](https://img.shields.io/badge/ndr_ui-docs-blue.svg)](https://www.rubydoc.info/gems/ndr_ui)\n\nThis is the NHS Digital (NHS-D) National Disease Registration (NDR) User Interface rubygem,\nproviding a set of core features:\n\n1. jQuery\n2. [Bootstrap](http://getbootstrap.com)\n3. a Bootstrap based Rails Form Builder\n4. ~~Bootstrap based pagination links~~\n5. Bootstrap based Rails Helpers\n\nand a set of opt-in plugins:\n\n1. Bootstrap based [datepicker](https://github.com/eternicode/bootstrap-datepicker)\n2. [Timeago](https://github.com/rmm5t/jquery-timeago) jQuery plugin and Rails Helper\n\nAdding third-party plugins to the gem allows us to fix our systems to clearly defined\nversions of the third-party libraries and enables us to add syntactic sugar (in the form of\npreferred setup/defaults and rails helper methods, for example).\n\nTo experiment with the code, run `bin/console` for an interactive prompt.\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'ndr_ui'\n```\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install ndr_ui\n\n## Usage\n\nRequire NdrUi javascripts at the top of `app/assets/javascripts/application.js`:\n\n```javascript\n//= require ndr_ui\n```\n\nImport NdrUi styles at the top of `app/assets/stylesheets/application.scss`:\n\n```scss\n/*\n*= require ndr_ui\n*/\n```\n\nRequire NdrUi::BootstrapHelper near the top of `app/controllers/application_controller.rb`:\n\n```ruby\nclass ApplicationController \u003c ActionController::Base\n  ...\n\n  helper NdrUi::BootstrapHelper\nend\n```\n\n### Datepicker\n\nTo use the Bootstrap based [datepicker](https://github.com/eternicode/bootstrap-datepicker), require it after ndr_ui. For example:\n\nIn `app/assets/javascripts/application.js`:\n\n```javascript\n//= require ndr_ui\n//= require ndr_ui/datepicker\n```\n\nIn `app/assets/stylesheets/application.scss`:\n\n```scss\n/*\n*= require ndr_ui\n*= require ndr_ui/datepicker\n*/\n```\n\nUse `\u003c%= form.datepicker_field(method, options) %\u003e` in your Bootstrap forms (see the method documentation for more details).\n\n### Timeago\n\nTo use the [Timeago](https://github.com/rmm5t/jquery-timeago) jQuery plugin and helper method:\n\nRequire it after ndr_ui at the top of `app/assets/javascripts/application.js`:\n\n```javascript\n//= require ndr_ui\n//= require ndr_ui/timeago\n```\n\nRequire NdrUi::TimeagoHelper near the top of `app/controllers/application_controller.rb`:\n\n```ruby\nclass ApplicationController \u003c ActionController::Base\n  ...\n\n  helper NdrUi::BootstrapHelper\n  helper NdrUi::TimeagoHelper\nend\n```\n\nUse `\u003c%= timeago_tag(some_time) %\u003e` in your views (see the helper method documentation for more details).\n\n### NDRS Styling\n\nTo use the NDRS Styling:\n\nrequire it after ndr_ui and after any bootstrap styling. For example:\n\nIn `app/assets/stylesheets/application.scss`:\n\n```scss\n/*\n*= require bootstrap-table\n*= require ndr_ui\n*= require ndr_ui/ndrs_styling\n*/\n```\n\n## Development\n\nAfter checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.\n\nTo install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/NHSDigital/ndr_ui.\n\nThis project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org/) code of conduct.\n\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnhsdigital%2Fndr_ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnhsdigital%2Fndr_ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnhsdigital%2Fndr_ui/lists"}