Skip to content

Lindurion/closure-bxr-starter

Repository files navigation

closure-bxr-starter

Starter node.js project using Closure Tools, Bootstrap, Express, and RECESS. Designed for you to fork or duplicate it to start your own project.

  • Closure Tools: JS compiler, Soy templates for HTML (via closure-pro-build package)
  • Bootstrap 3: Mobile-first responsive layout CSS framework
  • Express 3: Node.js HTTP server & web application framework
  • RECESS: CSS & LESS compiler supporting color constants, functions, mixins, etc.

Also includes jQuery 1.9 as part of Bootstrap support.

Usage

(First time only) Install node.js package dependencies:

$ npm install

Run lint checks for good code conventions & style (edit lint.js to customize checks):

$ node lint.js

Build your JS and CSS (include --debug for human-readable output):

$ node build.js [--debug]

Run server:

$ node server.js [--debug] [--port=8080] [--watch]

Then view in a web browser at http://localhost:8080/.

You can either rerun build.js manually after making edits, or you can pass the --watch command-line flag when you run the server, which will listen for changes to files under this directory and automatically rebuild the project on next request if any files have changed.

On Mac OS X, you may need to up your ulimit for --watch to work (since it opens many child processes):

$ ulimit -n 4096

Also, some editors seem to work better than others at notifying the OS when a file changes.

Customize input files and output directories for the project by editing project-config.js.

System Requirements

Java 7+ and Python version 2 must be installed and part of the system path as java and python in order to run all Closure tools. These commands are also configurable; see closure-pro-build documentation for more details.

License & Copyright

This package is released under the Apache License, Version 2.0. See LICENSE file for details.

License information for 3rd party tools used can be found under the 3p/ folder. License information for other npm packages used can be found in the information and/or source code for those packages listed on the npm website.

Copyright © 2013 Eric W. Barndollar.

About

Closure + Bootstrap + Express + RECESS, starter project

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published