Skip to content
This repository has been archived by the owner on Aug 27, 2019. It is now read-only.

18F/Paid-Leave-Prototype

Repository files navigation

Paid Family & Medical Leave Prototype

Code Climate CircleCI

This prototype was built by 18F, in partnership with the Department of Labor's Women's Bureau. Our goal was to provide a simple front-end, and some guidance on potential back-end structures, so that any jurisdiction with a Paid Family Medical Leave program can more easily create a website for it. The prototype is available now. Notable subsets of the prototype include a public-facing application process and a healthcare-provider patient-approval process.

Development

Development is in the 18f-pages branch.

Project Management

Feel free to open an issue if you'd like to request a feature. You can also look at our issues-tracking system on Trello.

Technical Approach

With a goal of constructing a modular, extensible, lightweight easily-customizable platform, this prototype employs several notable processes:

  • The site is constructed in Jekyll.
  • It is built entirely in JavaScript, to ensure that it can be hosted in any server environment.
  • The application form is encoded as JSON Schema, with JSON Form used to dynamically generate the HTML for the form. (No form data is present within the application page's HTML—it is all rendered in-browser, via JavaScript.)
  • Upon submission, form contents are submitted against the JSON Schema before being submitted to a RESTful endpoint (a server to be provided by the state implementing this prototype software).

Making changes to the form and validation process can be done by modifying the schema, with some particular HTML customizations possible via extensions to the schema in the form JSON. See the JSON Form documentation for specifics about this.

Because the form is generated from JSON, it would not be difficult to extend this prototype by adding a web-based form-building system, permitting customizations to the form without necessitating editing any JSON or HTML.

Local Development

This can be deployed locally with the following commands:

git clone https://github.com/18F/Paid-Leave-Prototype.git
gem install jekyll bundler accesslint-ci
jekyll serve --watch

Third Party Javascript Libraries

Contributing

See CONTRIBUTING for additional information.

Public domain

This project is in the worldwide public domain. As stated in CONTRIBUTING:

This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.

All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.