Skip to content
This repository has been archived by the owner on Aug 27, 2020. It is now read-only.

Home

Jump to bottom
Gregory McMullen edited this page Jun 29, 2016 · 2 revisions

Welcome

The template redevelopment is to focus on a cleaner core code base and integrating WCAG 2.0 Standards within the V4 Template.

This Wiki will house basic information on the techniques used to generate the new code.

Workflow Model

View the Workflow Overview prior to continuing on.

  1. Local: Pull the latest code from origin/master.
    1. Branch from Master and work on your code.
    2. Push to origin/BRANCHNAME
    3. Create a pull request
    4. Code will be reviewed and the PR will be merged.
  2. Remote: Named origin. This repository Branches include:
    1. Master - Production level code. Nothing merged here without a pull request and code review
    2. Other Branches - Feature/Issue/Hotfix branches. Pushed to origin merged via pull request.

Dependencies

Dependency installation instructions.

  • Git - Source Control
  • Node.JS - Package ecosystem, required for below
    • NPM - development package management (Grunt)
    • Bower - front-end package management (jQuery, Bootstrap, etc)
    • Grunt - Task Runner (SASS/JS compiler)

Contributing

Contributions to this repository should be made using the GitHub Flow branching model linked above.

  1. Keep the master branch clean, branch all work off of it.
  2. Commit and commit often. Use these guidelines for commit messages.
  3. Feature branches get pushed to remote.
  4. Open a pull request at bitbucket.org once dev has been updated.

Deployment

These commands may change and/or update once development starts moving. This is a reference guide from the previous repository.

Grunt commands will be used to deploy code locally, dev or to production. The following commands are the available, check Gruntfile.js for additional commands:

  • grunt watch - Watches all files in the SCSS, JS or Image folders. Will compile/concat/minify as appropriate for the file changed. Should always be running when modifying files.
  • grunt dev - Similar to watch but will only run tasks once. This should be used to get a development copy of the SASS files (with comments, nested format)
  • grunt live - Similar to dev but compiles with production in mind. JS and CSS files are minified.
  • grunt launch-dev - Runs grunt dev and copies the files to \Volumes\webcontent\webdev\temp-v4
  • grunt launch-live - Runs grunt live and copies files to \Volumes\webcontent\xu\live\Templates\temp-v4.1 - Should only ever be run from master

Other tasks can be found in Gruntfile.js and can be run as follows: grunt TASK:SUBTASK

Getting Started

Recommendation is to connect to this Repository via SSH. Instructions.

If you do not have a local ColdFusion environment, you might want to get one for testing purposes. The development environment is free for local installs.

If you have not installed Git, NPM, Bower or Grunt, follow the installation guide. After that, proceed here.

cd To/Your/Path
git clone [email protected]:XavierUniv/v4-template-redevelopment.git
cd v4-template-redevelopment

After cloning the repository locally run the following commands:

  • npm install - This installs the dependencies outlined in package.json
  • bower install - This installs the dependencies outlined in bower.json

Use npm update or bower update periodically, especially when pulling to ensure dependencies haven't changed. Submit an issue to discuss new versions of items.

After running these commands, you are good to start writing code. At a bare minimum, run grunt watch while coding if you want immediate access to changes.

Clone this wiki locally