search

uswds / uswds-sandbox

11ty site for rapid web prototyping and testing new work with USWDS
20 stars 14 forks source link

readme

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.

Requirements

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.

Installing USWDS from a branch

If you have made changes to the uswds project and want to test it with uswds-sandbox:

  1. Push your changes to uswds to a branch on GitHub.
  2. In your uswds-sandbox working copy, run npm install "https://github.com/YOUR_USERNAME/uswds/tree/YOUR_BRANCH" --save where the URL refers to your uswds branch.
  3. Run npm install to install dependencies including your new version of uswds.
  4. Run npm run init.
  5. Run npm start and open http://localhost:8080.

Templates