The US Forms System (USFS) is an open source library and set of guiding principles for building complex web-based forms. It consists of:
- Form widgets that emphasize accessibility, using the US Web Design System (USWDS);
- Navigational frameworks that can be used to split large forms into smaller pages;
- A declarative language and parser for specifying forms, based on JSON; and
- Starter apps that simplify the process of building a form from scratch.
The easiest way to get started is to install one of the starter apps, since they integrate all the components for you. However, you can also build your own sets of widgets or navigational components and use only the declarative language, for example.
TODO: links to updated docs (in a repo, or just markdown?)
Please read our Code of Conduct and CONTRIBUTING.md for more details.
To receive regular updates about this project, please join our mailing list by sending an email to forms-subscribe-request@listserv.gsa.gov.
If you want to directly contact the project team, you can send your questions to forms@lists.usds.gov.
The project is organized as a monorepo containing all the closely-related sub-projects. It is managed by lerna.