University of Tennessee, Knoxville Design System Theme

---

The Official UT Digital Design System Theme (UTKSDS) was made to help UT web developers build interfaces that match UT's visual identity and make consistent the user interface of a variety of digital products.

---

Installing this project

Step 1, Installing the requirements:

The UTKSDS uses Node and Gulp to compile and compress Javascript and CSS from source files. To modify this project, you must use Node 14 and Gulp.

1. Not required, but highly recommended. Install NVM by following these instructions. Mac Users: If you get an "nvm: command not found" error after running the install script (and you likely will), be sure to follow the troubleshooting steps.
2. Install Node.js Important: Install using NVM (recommended).

Step 2, Installing the this project:

1. Download or git clone this project by typing git clone git@github.com:utkwdn/utksds-framework.git.
2. In your terminal, change to the new /utksds-framework/ directory.
3. Ensure you are running Node.js 14 prior to installation, by typing node -v
4. Type npm install to install dependencies.

---

Developing or building the theme

The NPM commands are:

• npm run dev runs continually and watches the \src\ directory for changes. When you change a file, it rebuilds the theme in the \build\ directory.
• npm run build will build a testing theme.
• npm run dist will minimize all images and css and javascript for production and place a production ready version of the theme in the \dist\ directory.

Note: The JS and CSS is edited in the framework project. The theme references javascript and css files on the images server.