1. Create a new project.
2. Copy these files into the new project.
3. Update the README, replacing the contents below as prescribed.
4. Add any libraries, assets, or hard dependencies whose source code will be included in the project's repository to the Exceptions section in the TERMS.

• If no exceptions are needed, remove that section from TERMS.

5. If working with an existing code base, answer the questions on the open source checklist
6. Delete these instructions and everything up to the Project Title from the README.
7. Write some great software and tell people about it.

Keep the README fresh! It's the first thing people see and will make the initial impression.

Description: The Teacher Digital Platform (TDP) will be a new section within the existing cf.gov website to promote the CFPBs financial education building blocks research. It will offer teachers resources to assist them with instructing students in K-12 grades on financial education topics.

This platform contains work for three separate projects: Building blocks tool, Curriculum review tool, and Search interface.

Description: The journey to adult financial well-being - A single page that will take users on a journey from adult financial well-being, to financial capability in youth, to the building blocks, and ending on a call to action. The call to action will focus on telling educators how they can easily incorporate the building blocks in their classroom.

• Technology stack: Jinja2 template, inline SVG images, CSS, and JS.

• Live site: The journey to adult financial well-being

• Dependencies: smoothscroll polyfill, animate on scroll

• Jinja2: A single template file is used (bb-tool.html).

• CSS: This page pulls in the platform’s global style sheet (tdp.less). The tour molecule contains most of the styles specific to this page. This page also uses the styles from the animate on scroll library.

• JS: This page pulls in the platform’s global JavaScript file (tdp.js). The scroll.js module handles the smooth scrolling to the different tour stops and depends on the smoothscroll polyfill to work in older browsers. This page also uses the script from the animate on scroll library.

Description: The Curriculum review tool is an interactive, online tool for educators to use in place of the paper-based PDF that already exists on the cf.gov website.

Further documentation about the CR tool can be found in the crtool directory.

Description: The goal of the searchable interface is to create a repository for financial education activities that teachers can use to easily find and download activities and activity ideas to use in their classroom. The searchable interface serves as a end-point for a teacher who has learned more about teaching Financial Education through reviewing the content within the Building Blocks tool section. Once they've learned about how to incorporated financial education into their classroom through the Building Blocks tool, they can now put those ideas into action through utilizing activities and handouts from this searchable interface.

• Technology stack: Python, Django, Wagtail, Elasticsearch, Jinja2 template, inline SVG images, CSS, and JS.

• Status: Beta

• Live site: searchable interface

Screenshot:

TDPActivityPage:

• Extends: CFGOVPage

• Description: A TDP Activity Page is used to populate search results in the TDPActivityIndexPage and provide detail pages for various classroom activities. This model has many metadata fields that are used as filters on the Search page.

BaseActivityTaxonomy:

• Extends: models.Model

• Description: This is a base (abstract) Model on which most metadata fields are based (ActivityTopic being the exception). You can edit these field options in the Wagtail admin menu by going to "TDP Activity > [Label]"

• Fields:

  • title: A unique string field that serves as the filter value label

  • weight: An integer that determines the labels ordering when listed

• Models that extend BaseActvitityTaxonomy:

  • ActivityAgeRange: e.g: "13-15", "16-19", etc.

  • ActivityBloomsTaxonomyLevel: e.g: "Remember", "Understand", etc.

  • ActivityBuildingBlock: e.g: "Executive function", "Financial habits and norms", etc.

  • ActivityCouncilForEconEd: e.g: "Standard I. Earning income", etc.

  • ActivityDuration: e.g: "15-20 minutes", etc.

  • ActivityGradeLevel: e.g: "High school (9-10)", etc.

  • ActivityJumpStartCoalition: e.g: "Spending and saving", etc.

  • ActivitySchoolSubject: e.g: "CTE (Career and technical education)", etc.

  • ActivityStudentCharacteristics: e.g: "Rural", "English language learners", etc.

  • ActivityTeachingStrategy: e.g: "Cooperative learning", "Gamification", etc.

  • ActivityType: e.g: "Individual", "Whole class", etc.

ActivityTopic:

• Extends: MPTTModel

• Description: This model allows us to have nested Topics

• Fields:

  • title: A unique string field that serves as the filter value label

  • weight: An integer that determines the labels ordering when listed

  • parent: A TreeForeignKey to the parent topic.

• Note: This model's nested admin ui breaks in the Wagtail admin, so it is managed in the django admin

TDPActivityIndexPage:

• Extends: CFGOVPage

• Description: The TDP Activity Search Page is a filterable listing page that displays published TDP Activity Pages. There is logic in the code that limits the site to only have one instance of a TDPActivityIndexPage. This is a Wagtail editable page that is powered by Haystack and Elasticsearch. For that reason, results will not display until you run:

python manage.py update-index -r teachers_digital_platform

• Fields:

  • header: A Streamfield that allows for TextIntroduction molecules

• django-haystack: The search page requires haystack and elasticsearch

• django-mptt (0.9.0): MPTT is used to provide hierarchical topic metadata via the ActivityTopic model

• django-js-asset (1.1.0)': JS Asset is a dependency of django-mptt

Detailed instructions on how to install, configure, and get the project running. This should be frequently tested to ensure reliability. Alternatively, link to a separate INSTALL document.

• You must first clone and install the cfgov-refresh repository

• Clone this repository into the develop-apps folder of the cfgov-refresh repository located here: cfgov-refresh/develop-apps

• Install third-party dependencies and build frontend assets:

cd develop-apps/teachers-digital-platform/
./setup.sh

This app uses Gulp to generate a single global CSS and JS files based on individual .less and .js files in "teachers_digital_platform/css" and "teachers_digital_platform/js." The generated css and js files can be found "teachers_digital_platform/static/"

You can generate all static files running the setup.sh script or running gulp

cd develop-apps/teachers-digital-platform/
./setup.sh

or use gulp:

gulp
gulp scripts
gulp styles

###Testing Javascript code:

Javascript tests can be fount in "teachers_digital_platform/__tests__"

to only test Search Tool JS, run:

npm run test-js

to test both the Search Tool and CRTool, run:

npm run test

###Testing Python code:

Unit tests can be found in "teachers_digital_platform/tests/"

The two main files are:

• teachers_digital_platform/tests/models/test_activity_index_page.py

• teachers_digital_platform/tests/models/test_pages_utility_definitions.py

Shell command:

tox

Currently, there are no error notifications when the Elasticsearch server is down. Errors are sent to console log, but is not prominently displayed for end-users.

If you have questions, concerns, bug reports, etc, please file an issue in this repository's Issue Tracker.

1. TERMS
2. LICENSE
3. CFPB Source Code Policy

1. This project was heavily influenced by work done on the regulations3k project.