cfpb / curriculum-review-tool

An interactive tool that allows a teacher to assess the merits of a financial education curriculum.
https://www.consumerfinance.gov/practitioner-resources/youth-financial-education/curriculum-review/
Creative Commons Zero v1.0 Universal
10 stars 14 forks source link

Split the Curriculum Review Tool out into its own Django app #392

Closed cwdavies closed 4 years ago

cwdavies commented 4 years ago

We want to migrate the Wagtail-dependent portions of the teachers-digital-platform app into cfgov-refresh to reduce complexity that the circular dependency between cfgov-refresh and teachers-digital-platform creates. This, the isolation of crtool into its own Django app, is a first step along that path.

Additions

Testing

  1. Pull branch
  2. ./setup.sh
  3. Install for local development via the develop-apps folder or pip install -e
  4. Add the following to cfgov/cfgov/urls.py:

        re_path(
           r'^practitioner-resources/youth-financial-education/curriculum-review/',  # noqa: E501
           include('crtool.urls')
       ),
  5. Add crtool to INSTALLED_APPS in cfgov-refresh/cfgov/cfgov/settings/base.py
  6. Test out http://localhost:8000/practitioner-resources/youth-financial-education/curriculum-review/ and http://localhost:8000/practitioner-resources/youth-financial-education/teach/activities/
  7. Compare with production and ensure they look and function they same

Todos

In future PRs:

  1. Move the Wagtail-dependent teachers_digital_platform app into cfgov-refresh/cfgov
  2. Clean up the organization of the crtool app remaining in this repo

Checklist

Scotchester commented 4 years ago

The items that were in the teachers_digital_platform/__tests__/ folder pertain to the activity search interface, not the CR Tool, and should not be moved into the crtool/ folder.

cwdavies commented 4 years ago

The items that were in the teachers_digital_platform/__tests__/ folder pertain to the activity search interface, not the CR Tool, and should not be moved into the crtool/ folder.

Moved __tests__ folder from crtool folder into teachers_digital_platform folder