Skip to content

uiowa/brand-icon-browser

Repository files navigation

Icon Browser

https://icons.brand.uiowa.edu

NOTE: this project uses a specific version of node.js. Ensure you run the nvm use command before doing any large amounts of developing.

Setting up development environment

Using the right version of node

nvm use

Follow any installation instructions given.

Project setup

npm install

Compiles and minifies for production

npm run build

Compiles and hot-reloads for development

npm run serve

Compiles and minifies but skips generating the icon variants (for testing purposes)

npm run build-no-icons

Adding new icons to Icon Browser

  1. Follow the steps on the Brand Icons repository for adding the correct icon image file variants and adding keywords to icons in the uiowa-brand-icons package.
  2. Check out a new branch. Example: icons_dep_update_aug_22
  3. Update the commit hash for the uiowa-brand-icons package in package.json's dependencies.

Example:

"uiowa-brand-icons": "git+https://github.com/uiowa/brand-icons.git#6f5c33e"

  1. Run npm update uiowa-brand-icons
  2. Test the icons you've added by running npm run build followed by npm run serve to ensure the build succeeds and that the new icons are available on localhost.
  3. Create a PR to merge this branch into main
  4. Upon merging into main, icons.brand.uiowa.edu should update automatically via GitHub actions within ten minutes.

Customize configuration

See Configuration Reference.

Brand icon information

See https://brand.uiowa.edu/graphic-elements for more information.