Skip to content

Latest commit

 

History

History
98 lines (62 loc) · 4.06 KB

README.md

File metadata and controls

98 lines (62 loc) · 4.06 KB
Raw

10x Forms Platform

Test bed for 10x forms tooling, completed as part of the 10x Forms Platform project.

Overview

A C4-like architectural diagram is available here.

Additional documentation:

Overview

The platform is made up of the following high-level terms.

Key personas

  • Form Builders: government program office staff or UX experts who create and publish "guided interview" web experiences for members of the public and fellow government staff via a friendly browser-based app, no coding necessary. For examples of "guided interview" style web experiences, check out IRS Direct File (filing your taxes), GetCalFresh (Applying for food benefits) and Court Forms Online (filing court documents).
  • Form Fillers: folks who provide info to the government via guided interviews created by Form Builders

Things

  • Blueprint: produced by a form builder, the blueprint defines the structure of an interactive session between a government office and a form filler.
  • Conversation: one instance of a blueprint; the interactive session between a government office and a form filler. Other terms for this concept include dialogue or session.
  • Pattern/template: the building blocks of a blueprint, patterns implement UX best-practices, defining the content and behavior of the user interface.
  • Prompt: produced by a pattern, the prompt defines what is presented to the end user at single point in a conversation.
  • Component: user interface component that acts as the building block of prompts.

Development

This project uses the version of Node.js defined in .nvmrc. To ensure you're using the correct node version, you may use the Node Version Manager (NVM):

nvm install

This project uses pnpm workspaces. To work with this project, install pnpm and then the project dependencies:

pnpm install

To install the browsers needed for the Storybook testing with @vitest/browser, you need to do a one-time install with pnpm dlx [email protected] install --with-deps. This command also needs to be run when Playwright is updated because it requires version parity to find the executables across the local dev environment and CI to get all the tests to pass. To run the complete test suite, with coverage metrics generated:

pnpm test

To run tests, you will need to have either Podman or Docker Desktop installed to enable PostgreSQL to start in a container before the tests execute. While we support both Docker and Podman, we recommend using Podman as a free alternative. For detailed setup instructions, refer to the Podman Desktop Integration guide.

To run tests in watch mode (except the infra tests, which use Jest):

pnpm vitest

If you start having unexplained build errors, the following commands are useful to clean up and start fresh.

pnpm clean:dist # removes previously built files recursively
pnpm clean:modules # removes node_module directories recursively

# ... run more commands like pnpm install and pnpm build after you have run these

To start developing with hot reloading, use:

pnpm build

then run:

pnpm dev

These local servers will be started:

To lint the source code:

pnpm lint

Command-line interface

A command-line interface is provided for manually running operations. The corresponding app resides in ./apps/cli. A wrapper script, in the root directory, is provided.

./manage.sh --help