-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'dependabot/npm_and_yarn/ejs-3.1.10' of github.com:uswds…
…/uswds-sandbox into cm-POAM-may-2024
- Loading branch information
Showing
2 changed files
with
12 additions
and
2 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 +1 @@ | ||
18 | ||
20 |
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,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 |