https://github.com/gsa/cto-website
Tech at GSA website
https://github.com/gsa/cto-website
css federalist hugo javascript sass
Last synced: about 1 year ago
JSON representation
Tech at GSA website
- Host: GitHub
- URL: https://github.com/gsa/cto-website
- Owner: GSA
- License: other
- Created: 2016-06-13T17:24:20.000Z (about 10 years ago)
- Default Branch: main
- Last Pushed: 2025-03-29T04:40:10.000Z (over 1 year ago)
- Last Synced: 2025-03-29T05:09:46.236Z (over 1 year ago)
- Topics: css, federalist, hugo, javascript, sass
- Language: JavaScript
- Homepage: https://tech.gsa.gov/
- Size: 144 MB
- Stars: 51
- Watchers: 20
- Forks: 71
- Open Issues: 37
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Tech at GSA website
This is the website for the GSA Office of the Chief Technology Officer.
## Architecture
This is a [Hugo-based](https://gohugo.io/) website designed to be published on the
[cloud.gov Pages](https://pages.cloud.gov/) platform.
The website utilizes the [US Web Design System](https://designsystem.digital.gov/).
## Setup
### Install Prerequisites
Ensure you have the following installed on your local machine:
* [Hugo](https://gohugo.io/getting-started/installing/)
* [Node.js](https://nodejs.org/en/)
### Building and previewing the website
First, install the project's dependencies:
```
npm install
```
Then you can run the site locally with live reloading and local CMS:
```
npm start
```
You should now be able to preview the site on your local machine at [http://localhost:1313/](http://localhost:1313/). The CMS is at [http://localhost:1313/admin/](http://localhost:1313/admin/).
## Development
### Assets
This project uses [Hugo Pipes](https://gohugo.io/hugo-pipes/) to manage most static asset files. It also uses [uswds-compile](https://github.com/uswds/uswds-compile) to manage USWDS-specific assets, as well as the site's stylesheet.
To override USWDS settings, edit [assets/sass/uswds-settings.scss](/assets/sass/uswds-settings.scss). We generally prefer to customize these settings rather then create new CSS style declarations when possible.
To edit site styles, use [assets/sass/styles.scss](/assets/sass/styles.scss).
After changing the styles, recompile them with `npx gulp compile`. Or you can automatically compile edited Sass files during development by running: `npx gulp watch` or just `npx gulp`.
Note that when updating USWDS to a newer version, it may be necessary to manually merge the newer files with the customizations to ensure that USWDS is importing the site's custom styles file.
## License
As a work of the United States Government, this project is in the public domain
within the United States.