Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cfpb/wagtail-regulations
Building blocks for interactive regulations in Wagtail
https://github.com/cfpb/wagtail-regulations
django hacktoberfest wagtail
Last synced: 17 days ago
JSON representation
Building blocks for interactive regulations in Wagtail
- Host: GitHub
- URL: https://github.com/cfpb/wagtail-regulations
- Owner: cfpb
- License: cc0-1.0
- Created: 2019-05-20T20:27:30.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-07-06T20:26:47.000Z (over 2 years ago)
- Last Synced: 2024-12-02T16:36:50.405Z (21 days ago)
- Topics: django, hacktoberfest, wagtail
- Language: Python
- Homepage:
- Size: 711 KB
- Stars: 8
- Watchers: 27
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Wagtail-Regulations
[](https://github.com/cfpb/wagtail-regulations/actions?query=workflow%3Atest)
[](https://coveralls.io/github/cfpb/wagtail-regulations?branch=master)
Building blocks for interactive regulations in Wagtail.
- [Dependencies](#dependencies)
- [Installation](#installation)
- [Usage](#usage)
- [Getting help](#getting-help)
- [Getting involved](#getting-involved)
- [Licensing](#licensing)
- [Credits and references](#credits-and-references)
## Dependencies
- Django 1.11+ (including Django 2.0+)
- Wagtail 1.13+ (including Wagtail 2.0+)
- Python 2.7+, 3.6+
## Installation
## Usage
### Components
Wagtail Regulations provides the building blocks to create and serve
interactive US federal regulations on existing Wagtail sites.
It is intended to integrate into sites that may have their base templates,
design language and components, and Wagtail base pages. It also provides
everything needed to stand-up a new interactive regulations site using the
US Web Design System.
The basic components are as follows:
#### Regulation content
Wagtail Regulations includes Django models that represent regulations, their
effective versions, subparts, and sections.
Regulation content is stored in `Section` objects in Markdown outside of the
Wagtail page tree.
#### Regulation pages
Regulation pages are routable Wagtail pages that live in the Wagtail page
tree and serve the regulation content from the
[regulation content](#regulation-content). Regulation pages can be used two
ways:
1. By inheriting from the abstract `wagtailregulations.RegulationPage` model
directly.
2. By creating a new page model using any `Page` subclass and
`RegulationPageMixin`.
#### Regulation search
Regulation content is indexed and searchable using Haystack.
#### Regulation API
The API provides access to the regulation pages and their content so that a
frontend can consume it.
#### Frontend
The frontend serves the regulation content and search to end users.
#### eCFR Parser
### Putting it all together
This repository comes with the Wagtail library to build an interative federal
regulations website as well as a functioning example of how to do so.
The example is broken into a Wagtail-based REST API and a Gatsy-based
front-end using the US Web Design System v2.0 that consumes that API.
#### API
The API can be run using
[Docker](https://docs.docker.com/engine/installation/) with
[Docker Compose](https://docs.docker.com/compose/install/):
```
docker-compose up
```
To load example regulation data with the necessary Wagtail pages
you'll need to create a superuser and then load the data:
```
docker-compose run app /venv/bin/python manage.py createsuperuser --username admin --email [email protected]
docker-compose run app /venv/bin/python manage.py loaddata sample_data.json
```
The regulation data should then be available at http://localhost:8000/api/v2/pages/4
## Getting help
Please add issues to the [issue tracker](https://github.com/cfpb/wagtail-regulations/issues).
## Getting involved
General instructions on _how_ to contribute can be found in [CONTRIBUTING](CONTRIBUTING.md).
## Licensing
1. [TERMS](TERMS.md)
2. [LICENSE](LICENSE)
3. [CFPB Source Code Policy](https://github.com/cfpb/source-code-policy/)
## Credits and references
1. Forked from [cfgov-refresh](https://github.com/cfpb/cfgov-refresh)