USWDS Tutorial

A tutorial project to learn about installing, compiling, and customizing with USWDS.

Requirements

• Node v16
• Ruby v3.0.2
• Git
• Access to a terminal application
• A text editor
• A modern web browser

Installation

1. Clone the tutorial repo, either in the terminal or with GitHub's Use this template button near the top of the page. We recommend using the terminal and the command line. If you choose to clone using the terminal, open a terminal window, navigate to the directory where you'd like to put the uswds-tutorial directory and run:

   git clone https://github.com/uswds/uswds-tutorial.git
   

   This will create a uswds-tutorial directory with the tutorial files inside. Navigate to this new directory:

   cd uswds-tutorial
   

2. Install the project dependencies:

   npm install
   

3. Start the tutorial server:

   npm start
   

4. Once the server is running, head to http://localhost:4000/ and follow the directions on the page!