Skip to content

Commit

Permalink
Merge branch 'dependabot/npm_and_yarn/ejs-3.1.10' of github.com:uswds…
Browse files Browse the repository at this point in the history
…/uswds-sandbox into cm-POAM-may-2024
  • Loading branch information
mahoneycm committed May 14, 2024
2 parents 8474a52 + c97257e commit 2b8be8e
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .nvmrc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
18
20
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,39 @@
# USWDS Sandbox

An eleventy site for rapid web prototyping and testing new work with USWDS. This site is designed to run locally and on [Cloud.gov pages](https://pages.cloud.gov/).

## Requirements
- Node v18 (LTS)

- Node v20 (LTS)

## Running code locally

After cloning the template repo, install USWDS, eleventy, and any necessary dependencies using:

```
npm install
```

Then, copy USWDS images, fonts, and JavaScript to a project directory.

```
npm run init
```

Finally, serve the site locally and watch for changes:

```
npm start
```

If all goes well, visit the site at http://localhost:8080.

USWDS assets will be in `assets/fonts` and `assets/img`.

SASS files will be in the `/_styles` directory. Running `npm start` will also watch these files and recompile when there are changes.

## Templates

- `default`: A blank-slate sandbox page
- `basic-prose`: A page with a banner, basic header, footer, identifier, and a prose container
- `extended-prose`: A page with a banner, extended header, footer, identifier, and a prose container

0 comments on commit 2b8be8e

Please sign in to comment.