Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md #476

Closed
wants to merge 3 commits into from
Closed

Update README.md #476

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7baaa82
Update README.md
kiranrokkam09 Oct 20, 2023
18e5533
Update README.md
kiranrokkam09 Oct 26, 2023
a1e3a3f
Update README.md
kiranrokkam09 Oct 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
**Description**:
This application allows consumers to search complaints submitted to the CFPB by other consumers.

**Website Link**:
[www.consumerfinance.gov](https://www.consumerfinance.gov/)
kiranrokkam09 marked this conversation as resolved.
Show resolved Hide resolved

#### Technology Stack

This application is written in JavaScript and [Less](http://lesscss.org) within
Expand All @@ -21,20 +24,17 @@ Unit testing of the application is performed within
[yarn](https://yarnpkg.com/) is used to manage the build/test/deploy cycle.

#### Screenshot

![screen August 17, 2017](documentation/screenshot.png)
![Consumer Financial Protection Bureau - Google Chrome 20-10-2023 10_37_09 PM](https://github.com/kiranrokkam09/ccdb5-ui/assets/85286397/90b9e381-f960-4c49-b956-0b8a254bcae3)
kiranrokkam09 marked this conversation as resolved.
Show resolved Hide resolved

## Dependencies

This application depends on the following third-party components:
This application leverages a robust design system, which serves as the foundation for maintaining a consistent and cohesive user interface. While the design system relies on various components and libraries, we'll focus on the design system as a whole, eliminating the need to list each individual dependency.

1. [Capital Framework](https://cfpb.github.io/capital-framework/) - CFPB standard styling and controls
1. [History](https://github.com/reacttraining/history) - Integrating the address bar with the application
1. [dayjs](https://day.js.org/) - Better date handling than native JavaScript
For detailed information about the design system and its underlying components, please refer to the official [Design System Documentation](https://thedesignsystem.guide/documentation). The design system provides standardized styling, controls, and guidelines, ensuring a unified user experience throughout the application.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not the design system we use. The CFPB has its own design system:
https://cfpb.github.io/design-system/

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, I think I'd dial back the verbiage on the design system. We don't need to sell it.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok then i will make the suggested changes.


It also contains portions adapted from:

1. [react-typeahead](https://github.com/fmoo/react-typeahead)
1. [React bootstrap typeahead](https://www.npmjs.com/package/react-bootstrap-typeahead)

## Installation

Expand Down