{"id":14036905,"url":"https://github.com/cfpb/wagtail-regulations","last_synced_at":"2025-09-09T16:35:30.275Z","repository":{"id":43384880,"uuid":"187708672","full_name":"cfpb/wagtail-regulations","owner":"cfpb","description":"Building blocks for interactive regulations in Wagtail","archived":false,"fork":false,"pushed_at":"2022-07-06T20:26:47.000Z","size":728,"stargazers_count":8,"open_issues_count":1,"forks_count":4,"subscribers_count":26,"default_branch":"master","last_synced_at":"2025-04-09T20:14:54.630Z","etag":null,"topics":["django","hacktoberfest","wagtail"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cfpb.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-05-20T20:27:30.000Z","updated_at":"2024-06-26T01:56:57.000Z","dependencies_parsed_at":"2022-07-08T21:00:39.157Z","dependency_job_id":null,"html_url":"https://github.com/cfpb/wagtail-regulations","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cfpb%2Fwagtail-regulations","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cfpb%2Fwagtail-regulations/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cfpb%2Fwagtail-regulations/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cfpb%2Fwagtail-regulations/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cfpb","download_url":"https://codeload.github.com/cfpb/wagtail-regulations/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248103872,"owners_count":21048245,"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":["django","hacktoberfest","wagtail"],"created_at":"2024-08-12T03:02:18.573Z","updated_at":"2025-04-09T20:15:01.380Z","avatar_url":"https://github.com/cfpb.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"# Wagtail-Regulations\n\n[![Build Status](https://github.com/cfpb/wagtail-regulations/workflows/test/badge.svg)](https://github.com/cfpb/wagtail-regulations/actions?query=workflow%3Atest)\n[![Coverage Status](https://coveralls.io/repos/github/cfpb/wagtail-regulations/badge.svg?branch=master)](https://coveralls.io/github/cfpb/wagtail-regulations?branch=master)\n\nBuilding blocks for interactive regulations in Wagtail.\n\n- [Dependencies](#dependencies)\n- [Installation](#installation)\n- [Usage](#usage)\n- [Getting help](#getting-help)\n- [Getting involved](#getting-involved)\n- [Licensing](#licensing)\n- [Credits and references](#credits-and-references)\n\n## Dependencies\n\n- Django 1.11+ (including Django 2.0+)\n- Wagtail 1.13+ (including Wagtail 2.0+)\n- Python 2.7+, 3.6+\n\n## Installation\n\n\n## Usage\n\n### Components\n\nWagtail Regulations provides the building blocks to create and serve \ninteractive US federal regulations on existing Wagtail sites. \nIt is intended to integrate into sites that may have their base templates, \ndesign language and components, and Wagtail base pages. It also provides \neverything needed to stand-up a new interactive regulations site using the \nUS Web Design System.\n\nThe basic components are as follows:\n\n#### Regulation content\n\nWagtail Regulations includes Django models that represent regulations, their \neffective versions, subparts, and sections. \n\nRegulation content is stored in `Section` objects in  Markdown outside of the \nWagtail page tree.\n\n#### Regulation pages\n\nRegulation pages are routable Wagtail pages that live in the Wagtail page \ntree and serve the regulation content from the \n[regulation content](#regulation-content). Regulation pages can be used two \nways:\n\n1. By inheriting from the abstract `wagtailregulations.RegulationPage` model \n   directly.\n2. By creating a new page model using any `Page` subclass and \n   `RegulationPageMixin`.\n\n\n#### Regulation search\n\nRegulation content is indexed and searchable using Haystack.\n\n\n#### Regulation API\n\nThe API provides access to the regulation pages and their content so that a \nfrontend can consume it.\n\n\n#### Frontend\n\nThe frontend serves the regulation content and search to end users.\n\n\n#### eCFR Parser\n\n\n\n### Putting it all together\n\nThis repository comes with the Wagtail library to build an interative federal \nregulations website as well as a functioning example of how to do so. \n\nThe example is broken into a Wagtail-based REST API and a Gatsy-based \nfront-end using the US Web Design System v2.0 that consumes that API.\n\n#### API\n\nThe API can be run using \n[Docker](https://docs.docker.com/engine/installation/) with \n[Docker Compose](https://docs.docker.com/compose/install/):\n\n```\ndocker-compose up\n```\n\nTo load example regulation data with the necessary Wagtail pages \nyou'll need to create a superuser and then load the data:\n\n```\ndocker-compose run app /venv/bin/python manage.py createsuperuser --username admin --email test@example.com\ndocker-compose run app /venv/bin/python manage.py loaddata sample_data.json\n```\n\nThe regulation data should then be available at http://localhost:8000/api/v2/pages/4\n\n\n## Getting help\n\nPlease add issues to the [issue tracker](https://github.com/cfpb/wagtail-regulations/issues).\n\n## Getting involved\n\nGeneral instructions on _how_ to contribute can be found in [CONTRIBUTING](CONTRIBUTING.md).\n\n## Licensing\n1. [TERMS](TERMS.md)\n2. [LICENSE](LICENSE)\n3. [CFPB Source Code Policy](https://github.com/cfpb/source-code-policy/)\n\n## Credits and references\n\n1. Forked from [cfgov-refresh](https://github.com/cfpb/cfgov-refresh)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcfpb%2Fwagtail-regulations","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcfpb%2Fwagtail-regulations","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcfpb%2Fwagtail-regulations/lists"}