0.0.1 • Published 9 years ago
backbone-marionette-boilerplate v0.0.1
#Backbone Marionette Boilerplate This is a platform for building SPA using Backbone and Marionette. It is a way of organizing your application. This boilerplate include:
- File structure
- Loading project dependencies with Bower
- Building you application with Grunt
- Using require.js for loading application dependencies
- Writing styles with Less
Simple web-server on Node and Express.js
##Getting started ####0. Install global dependencies Your have to install Git, download and install Node.
####1. Copy repo
# Clone only latest revision:
git clone --depth 1 https://github.com/sorokin-evgeni/backbone-marionette-boilerplate.git
# Remove .git folder
rm -rf backbone-marionette-boilerplate/.git
# Move files to your folder:
mv backbone-marionette-boilerplate my-project-name
####2. Update dependencies
# Globaly install bower
npm install -g bower
# Install NPM dependencies. You have to do it from your project folder.
npm install
# Install bower dependencies.
bower install
####3. Building project
# Run grunt tasks
grunt
####4. Starting your application
# Start node server
node server/app.js
Open in your browser http://localhost:3000.
##Files structure
# Only for production usage.
# All static keeps here: js and css bundles, generated initial index.html
dist/
# All static source code keeps here.
public/
# CSS and compiled css from less.
# All files from this folder will be included in bundle
css/
js/
# All application files
app/
# Backbone models which can be shared between any modules
models/
# Marionette modules. Independent parts of application
modules/
# Common views
views/
# All application dependencies. Uploaded from bower
lib/
# Application entry point
app.js
require.config.js
require.js
less/
# All client templates
templates/
server/
# Server templates. Now generate index.html
templates/
# Server application
app.js
Files structure is flexible. It can be changed by rewriting paths in config.json.
Environment variable also keeps in config.json.
##Licence
Copyright © 2014 Evgeny Sorokin.
Licensed under the MIT license.
0.0.1
9 years ago