kutayzorlu / twb

TWB Web App

TWB

To set up the app:

• To create the web application, there are a few external libraries which are necessary.
• Download Git Bash (http://git-scm.com/downloads). Open the Git Bash then download repository to the specified folder in your local machine via clone URL by typing 'git clone "url"'. The URL is provided on right hand side of this window.
• In Git Bash, go to project, type "cd TWB". You will be on master mode. Type "npm install -g bower" and type "npm install grunt" to install bower and grunt. Bower will help pulling dependencies that are written in bower.json. Then type "npm install" to install the dependencies. It will look the dependendies in the package.json file. You should now see node_modules folder under TWB. In node_module folder, you will see the devDependencies that are written in package.json.
• Later, type "bower install". The bower_components folder will be created with the dependent packages written in bower.json.
• To see the app in Chrome, install http-server by typing "npm install http-server -g" in bash. Then go to Chrome and type http://localhost:8080/src

Information about tools (no need for pulling dependencies or etc)

Node.js: Java Script for server-side.

• npm install packages (grunt, bower etc)
• Node.js command line should be installed. In order to install packages go: https://nodejs.org/
• If you want to add a library, such angularjs, bootstrap etc, to the project, the packages should be installed to project folder. To find package, try here: https://www.npmjs.com/
• Type "npm install -g package name"

Bower: Bower is needed to distrubute the application. In bower.json folder, all the dependencies can be found. Therefore, contribitors do not need to re-install each packages all the time. Bower: http://bower.io/

• Package manager for the web.
• Pulls down the necessary libraries
• Type npm install in git bash. This will create the node_modules folder.
• To pull down a package with bower, type "bower install package name". For example, "bower install angularjs".
• The package(s) will be installed to the bower_components folder.
• To check the installed packages, type "bower list".
• Type "bower init" to initialize.
• To uninstall a package, type "bower uninstall package name".

Grunt

• Type "npm install grunt" in git bash.
• In order to get started, you need Grunt's command line interface. It will put grunt command in your system path.
• In Bash, type "npm install -g grunt-cli".
• CLI loads the local installation of the Grunt library, applies configuration from the GruntFile.
• For more information: http://gruntjs.com/getting-started
• GruntFile.js install grunt plugins and configure-define tasks.