Theme description: A WVU branded template for Catalog.wvu.edu made with vanilla HTML. This template could be easily adapted to apply WVU's brand to other applications.
Developers name(s): Adam Johnson
Github repository URL: https://github.com/wvuweb/catalog-static
Site URL: Production: https://catalog.wvu.edu. Development: https://wvuweb.github.io/catalog-static/
Dependencies: NodeJS, Gulp, all of it's dependencies and Node packages.
- Navigate to your project via Terminal (maybe:
cd ~/Sites/catalog-static?) - Type
gulpand hit enter. - Visit
http://localhost:3000in your browser.
¡Hola! If you're new here, follow these steps:
- Install Node at http://nodejs.org/.
- Install Ruby (if you're on a Mac, you can skip this step): https://www.ruby-lang.org/en/downloads/.
- Install Gulp via the directions on their website.
- In your terminal, navigate to wherever you cloned this repo (maybe
cd ~/Sites/catalog-static/?) - Install the dependencies for the project:
npm install
- Make sure there are no errors in your terminal (they usually appear in red). If there are, search the web for an answer or try prefixing some commands with
sudo. - After everything is installed, follow the instructions above on "How to run Gulp".
This repo comes with both an EditorConfig file and SCSS Lint file. Before making any modifications, consider installing EditorConfig and scss-lint.
Travis Maynard wrote a great article about how to get started with Gulp. I've already done the heavy lifting with Gulp by creating the gulpfile.js, but that article brings it back to the basics to help you get started.
If the dependencies in this project are old and you want to update your packages, follow these instructions.
WVU's course catalog is run and hosted by a third-party vendor called CourseLeaf. The WVU Registrar is in charge of the content while CourseLeaf handles the technical implementation (hosting, templating, support, etc).
This is a flat HTML template which uses styles from WVU's pattern library, Supertheme. Supertheme was built for CleanSlate CMS, WVU's mutli-site content management system. This template has abstracted the HTML from CleanSlate Radius Templates to flat, vanilla HTML. You could easily use this template to wrap any app or service with WVU branding. There's a psuedo "style-guide" in the tabs of this HTML file. You can also see more options on the Supertheme website.
This theme uses Sass and Gulp to compile the CSS. I have specifically commented out various partials in scss/1-base/base-dir.scss and scss/2-modules/modules-dir.scss because Catalog didn't use those patterns (performance!). If you want to use some of the commented out patterns (maybe you need two, three or four column stuff), follow the install instructions, run gulp and uncomment the requisite Sass partials.
This theme uses Helvetica Neue from fonts.com. We've whitelisted fonts.com to *.wvu.edu and local domains. As a result, the fonts will 404 if you preview them here on Github pages. To see the fonts in all their glory, clone the project and run Gulp.
If you have questions or need help, please contact Adam Johnson or any WVU University Relations team member. Don't be afraid to open an issue if it's related to this project.
The code is available under the MIT license.