team-bubbles / nmcs1

New Media Career Skill 1 Portfolio site. All rights reserved.
GNU General Public License v3.0
1 stars 2 forks source link

Portfolio Template

Portfolio Template built by a team of 5 RIT students. Kara Williams, Kaleigh Yang, Changbai Li, Jurian Hoff, Marco Fragale.

I'm currently in the process of converting this into a WordPress Theme, or use WordPress as backend for this.

How to use

  1. Follow the instructions below to set up the workflow
  2. For style changes, go to src/sass
  3. For html markup changes, go to src/htdocs
  4. Take all files in the build folder and put it at your root directory

Template Workflow

The template now uses a collection of tools, tasks, and workflows to make development easier and code quality higher.

Technologies include:

If you've never used Node or npm before, you'll need to install Node. If you use homebrew, do:

brew install node

Otherwise, you can download and install from here.

Afterwards, update npm with:

npm install npm -g

Install Gulp Globally

Gulp must be installed globally in order to use the command line tools. You may need to use sudo

npm install -g gulp

Alternatively, you can run the version of gulp installed local to the project instead with

./node_modules/.bin/gulp

Install npm dependencies

npm install

This runs through all dependencies listed in package.json and downloads them to a node_modules folder in your project directory.

Run gulp and be amazed.

gulp
For production, run gulp production.
For icon font generation, run gulp iconFont.

In Case It Breaks

Issues we ran in when working the flow on other machines, especially IGM lab machines:

(╯°□°)╯︵ ┻━┻)

Configuration

All paths and plugin settings have been abstracted into a centralized config object in gulp/config.js. Adapt the paths and settings to the structure and needs of your project.