careykwan / Behance-API

Group project using the Behance API to pull data

Behance API Summative | Pentagramer Designer Showcase

This project is a summative collaboration project for the Yoobee School of Design, Wellington's Web and UX course. The focus of this project is data visualising of the retrieved Behance API.

Terminal Commands

To get started this project requires a server therefore if you are using a Vagrant server please ensure you have Node JS install inside the server.

Installing Packages When you have cloned the project, please install the node_module packages with:

$ npm install

Grunt Commands

If you are not using a vagrant server, we have also implemented grunt's browser-sync that can be use by following simple commands below.

Before running the commands below, please ensure you have Node JS, Grunt CLI and SASS install on to your computer.

We have used Grunt as our task runner therefore to get things running, run the following commands in two seperate terminal tabs.

Open Server (if you are not using a Vagrant server)

$ grunt server

Run Sass compiler, Lint, Minify, etc

$ gunt w

JavaScript Style Guide

• Use single quotations within the JavaScript files.

• Use Tabs for indentations.

• Use camel case in JavaScript file as hyphenation are reserved for css and html naming.

• Have appropriate discriptive variable names.

• Have space between operators.

• Do not have objects written compressed on one line.

• Place the opening bracket on the same line as the object name and closing bracket on it own line.

Best Practices

All members coding their sub projects should only be coding within their project files to avoid constant conflict during commits.

• To avoid conflicts every member has been assigned a number to differentiate class and id names for css styling, the number will be added to every name created at the end. Unless certain IDs are required in order for pages to link.

• Each memeber must not work on the master branch, therefore they must work on their own seperate branches.

• The best practices we are following, will be the [Yoobee School of Design Web Best Practices](http://yoobee.net.nz/BestPractices/) guidelines, mainly focusing on the Client Side Best Practices section.

Collaborators

• [Carey Kwan](https://github.com/careykwan)

• [Kelsey Smith](https://github.com/Kelseys1993)

• [Florence Lo](https://github.com/fpwl)