The official University of Tennessee, Knoxville Web Design System 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.
The theme is built from the src
directory, using the directions listed under Installing this project. When built, all theme files will be in the build
directory.
The Torch WDS uses Node and Webpack compile the theme. You will need to install Node.js and NPM to build the theme.
- 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.
- Install Node.js Important: Install using NVM (recommended).
- Download or
git clone
this project by typinggit clone git@github.com:utkwdn/utkwds.git
. - In your terminal, change to the new
/utkwds/
directory. - Ensure you are running Node.js 16 prior to installation, by typing
node -v
- Type
npm install
to install dependencies.
- In your terminal, change to the
/utkwds/
directory. - Type
npm run build
to build the theme. - The theme will be built in the
/build/
directory.
Note: If you are using Visual Studio Code, the build process will automatically run when you open the editor. Tasks can be stopped and restarted using the Terminal
menu.
The NPM commands are:
npm run start
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. It also creates a zip file of the theme in the root directory that can be uploaded to WordPress.npm run wp-env start
will start a local WordPress environment for testing the theme. This requires Docker to be installed on your machine.npm run wp-env stop
will stop the local WordPress environment.npm run wp-env -- --xdebug
will restart the local WordPress environment with Xdebug enabled.