This boilerplate will help SharePoint web app developers to get start our app development framework and folder structure quickly. And its free to modify.
The backbone marionette boilerplate will organize your application with a logical file structure to develop your Models/Collections/Views/Routers inside require.js modules. and building process will be done by r.js also boilerplate has task runner winch using Gulp.js.
modernizr.js , text.js ( underscore template engine ), Backbone.SharePoint OData proxy by Luc Stakenborg, bootstrap 3 with less compiler and finally jQuery v1.10.2. feel free to add or update your favorite library's.
- Node.js installed in your computer if not install from http://nodejs.org/download/
The easiest way to get started is to install Git and clone the repository:
# Create your project folder.
> mkdir projectfolder
# CD into your project folder.
> cd projectfolder
# Clone it from github repository.
> git clone https://github.com/aCreativeDesign/backbone-marionette-boilerplate
# Installing dependencies
# CD into the folder and run following command.
> npm install
# And finaly.
> gulp init
If your not familiar with command line you can always download as zip from github. and change the folder name to your project name.
project-name |-- backups |-- client-brief |-- development | `-- css | `-- images | `-- js | `-- less |-- dist |-- node_modules
Backups folder will have backup of a development folder by running :
> gulp backup
Client-brief folder will have all your UI files such as Adobe Photoshop, InDesign. and maybe clients email...
Development folder will have all your development source files. ( heart of your project ). If your thinking of using Git (to track your changes)in your project then make a git init inside your development folder.
Dist folder Minifyed final product folder and also gulp.js runs as server under localhost:8888 will pointed into dist folder and it will reload on file change / watch.
node_modules folder will have all the node.js and gulp.js modules installed in local.
Inside less folder you will see style.less file will hold all your styles and variables also bootstrap folder will have less version of bootstrap.
Customizing bootstrap : inside bootstrap folder you will find a bootstrap.less file has all the components @imports you can comment over it or uncomment and run build.
The build process consists of numerous Gulp.js plugin tasks that work together to optimize your application.
# To run the build process, cd into the project folder root and run.
# It will run server under localhost:8888
> gulp
Some commands and features can be find here.
# Backup your development folders
> gulp backup
# Backup your development folders into your own path
> gulp backup --path ../your/file/path