Giter Club home page Giter Club logo

backbone-marionette-boilerplate's Introduction

backbone marionette boilerplate

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.

Library's used :

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.

Requirement :

Getting started

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.

Folder structure

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.

Less CSS processing

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.

Build process

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

Other Commands and features

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

backbone-marionette-boilerplate's People

Contributors

nufaylr avatar thunderliortest[bot] avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.