-
Notifications
You must be signed in to change notification settings - Fork 38
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #147 from usds/readme-cleanup
Clean up README
- Loading branch information
Showing
1 changed file
with
12 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,20 @@ | ||
# U.S. Forms System | ||
|
||
The US Forms System is an open source library and set of guiding principles for building complex web-based forms using [React](https://reactjs.org), the [JSON Schema standard](http://json-schema.org/), and the [US Web Design System](https://designsystem.digital.gov/). | ||
|
||
***THIS IS A WORK IN PROGRESS.*** | ||
|
||
Modelled after the [US Web Design System](https://designsystem.digital.gov/), this project creates an open source code library and set of guiding principles for building complex web-based forms significantly faster than existing methods, using best practices in user experience and data collection, validation, and transmission. | ||
### About this project | ||
|
||
Inspired by Mozilla's [react-jsonschema-form](https://github.com/mozilla-services/react-jsonschema-form) library, the US Forms System is specifically intended for consistently styled governmental web-based forms. This library enables you to describe form fields in a JSON Schema configuration file, which then renders the backing React components necessary to build your form. You'll build forms significantly faster than existing methods, and benefit from the US Web Design System's best practices in user experience and data collection, validation, and transmission. | ||
|
||
### Using the library | ||
|
||
This library enables you to build web-based forms using [React](https://reactjs.org) and the [JSON Schema standard](http://json-schema.org/). Instead of building and configuring your React components from scratch, use this library and guidance to describe the form fields in a JSON Schema configuration file, which will then render the backing React components necessary to build your form. | ||
For information about setting up and using the US Forms System, see the *[US Forms System Documentation](../docs/README.md)*. | ||
|
||
Originally inspired by Mozilla's [react-jsonschema-form](https://github.com/mozilla-services/react-jsonschema-form) library, we've created a version specific build web-based forms for government, styled using the [U.S. Web Design System](https://designsystem.digital.gov/) for a consistent look and feel across government. | ||
Additionally, the [US Forms System Starter App](https://github.com/usds/us-forms-system-starter-app) provides the basic files and configuration needed to get started building a form using the US Forms System. | ||
|
||
--- | ||
### More project artifacts | ||
|
||
We'll be documenting our roadmap, research, and process in [the wiki](https://github.com/usds/us-forms-system/wiki) as work on getting the code library ready. Feel free to look around [our wiki](https://github.com/usds/us-forms-system/wiki) and [our project board](https://github.com/orgs/usds/projects/3) if you want to follow along with our progress. That's also where developer documentation and best practices guidance for forms design and development will be found as it comes together. | ||
- Roadmap, research, and process: [US Forms System Wiki](https://github.com/usds/us-forms-system/wiki) | ||
- Project progress: [US Forms System Project Board](https://github.com/orgs/usds/projects/3) |