consumerfinance.gov

<<<<<<< HEAD <<<<<<< HEAD <<<<<<< HEAD <<<<<<< HEAD

This is a fork of the main cfgov-refresh for Raft's work on the Digital Money Toolkit project. Some of the Researc, Design, and Technical artifacts can be found in the Wiki

<<<<<<< HEAD This is a fork of the main cfgov-refresh for Raft's work on the Digital Money Toolkit project. Some of the Researc, Design, and Technical artifacts can be found in the Wiki

update readme

This is a fork of the main cfgov-refresh for Raft's work on the Digital Money Toolkit project. Some of the User Research, Design, and Technical artifacts can be found in the Wiki. The ReactJS codebase is integrated into Wagtail Django CMS as a satellite application. update the readme

This is a fork of the main cfgov-refresh for Raft's work on the Digital Money Toolkit project. Some of the User Research, Design, and Technical artifacts can be found in the Wiki. The ReactJS codebase is integrated into Wagtail Django CMS as a satellite application. update the readme

This is a fork of the main cfgov-refresh for Raft's work on the Digital Money Toolkit project. Some of the User Research, Design, and Technical artifacts can be found in the Wiki. The ReactJS codebase is integrated into Wagtail Django CMS as a satellite application.

Update README.md

This is a fork of the main cfgov-refresh for Raft's work on the Digital Money Toolkit project. Some of the User Research, Design, and Technical artifacts can be found in the Wiki. The ReactJS codebase is integrated into Wagtail Django CMS as a satellite application. c3666edae03fca89cbe1a6d87d5fb92eda58f43b

The master repository for consumerfinance.gov.

The primary repository for consumerfinance.gov.

dd7058e62b45d2d82162efac4d4c811c966977b9 This Django project includes the front-end assets and build tools, Jinja templates for front-end rendering, code to configure our CMS, Wagtail, and several standalone Django apps for specific parts of the site.

This is a fork of the main cfgov-refresh for Raft's work on the Digital Money Toolkit project. Some of the User Research, Design, and Technical artifacts can be found in the Wiki. The ReactJS codebase is integrated into Wagtail Django CMS as a satellite application.

2f304e78fb3c427c5ea45c707de5e97f1e93bfd7

Backlog

The backlog for this project is being maintained in the CFPB Enterprise GitHub whereas the bugs are captured in this fork.

Pull request process

We follow the following steps for developing and creating end-of-sprint pull-request reviews:

1. Raft developers create PR's from their branches into my-money-calendar
2. The PR is reviewed and issues are resolved as new commits to the same branch
3. The PR is merged after the manual review and the tests via CircleCI pass
4. A new PR is open from my-money-calendar to cfgov-refres/my-money-calendar
5. The PR follows the pull request template
6. The PR is reviewed/merged and deployed to CFPB dev servers
7. When functionality is ensured, a PR is opened from cfgov-refres/my-money-calendar to cfgov-refres/master

Backlog

The backlog for this project is being maintained in the CFPB Enterprise GitHub whereas the bugs are captured in this fork.

Pull request process

We follow the following steps for developing and creating end-of-sprint pull-request reviews:

1. Raft developers create PR's from their branches into my-money-calendar
2. The PR is reviewed and issues are resolved as new commits to the same branch
3. The PR is merged after the manual review and the tests via CircleCI pass
4. A new PR is open from my-money-calendar to cfgov-refres/my-money-calendar
5. The PR follows the pull request template
6. The PR is reviewed/merged and deployed to CFPB dev servers
7. When functionality is ensured, a PR is opened from cfgov-refres/my-money-calendar to cfgov-refres/master

<<<<<<< HEAD

Technical Overview

....

update the readme

Quickstart

Full installation and usage instructions are available in our documentation.

This project requires Python 3.6, Node 12, and Gulp 4. We recommend the use of virtualenv and virtualenvwrapper for keeping the project's Python dependencies contained.

Clone the repository:

git clone git@github.com:cfpb/consumerfinance.gov.git

Create a virtual environment for Python dependencies:

cd consumerfinance.gov
mkvirtualenv --python=python3.6 consumerfinance.gov

Create and load initial environment settings:

cp -a .env_SAMPLE .env
source .env

Install third-party dependencies and build frontend assets:

./setup.sh

Create a local database, a Wagtail admin user, and a site homepage:

./initial-data.sh

Start your local Django server:

./runserver.sh

Your site will be available locally at http://localhost:8000/.

The Wagtail admin area will be available at http://localhost:8000/admin/, which you can log into with the credentials admin/admin.

Documentation

Full documentation for this project is available in the docs/ directory and online.

If you would like to browse the documentation locally, you can do so with mkdocs:

pip install -r requirements/docs.txt
mkdocs serve

Documentation will be available locally at http://localhost:8000/.

Getting help

Use the issue tracker to follow the development conversation. If you find a bug not listed in the issue tracker, please file a bug report.

Getting involved

We welcome your feedback and contributions. See the contribution guidelines for more details.

Additionally, you may want to consider contributing to the Design System, which is the front-end pattern library used in this project.

Open source licensing info

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

Credits and references

This project uses Design System as the basis of its user interface and layout components.