https://github.com/creatorrr/browserify-boilerplate

A simple boilerplate for writing js libraries using browserify.
https://github.com/creatorrr/browserify-boilerplate

Last synced: 8 days ago
JSON representation

A simple boilerplate for writing js libraries using browserify.

• Host: GitHub
• URL: https://github.com/creatorrr/browserify-boilerplate
• Owner: creatorrr
• Created: 2013-04-28T07:04:57.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2013-08-30T03:15:58.000Z (about 11 years ago)
• Last Synced: 2024-10-14T11:43:19.301Z (about 1 month ago)
• Language: CoffeeScript
• Homepage:
• Size: 145 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
browserify-boilerplate

======================

A simple boilerplate for writing js libraries using [browserify](http://browserify.org/).

Installation

------------

1. [Fork](https://github.com/creatorrr/browserify-boilerplate/fork) / [download](https://github.com/creatorrr/browserify-boilerplate/archive/master.zip) the boilerplate and ```cd path/to/boilerplate```.

2. ```npm install && npm run-script``` to setup the project.

3. (Optional) ```npm install -g grunt-cli``` for using all grunt scripts.

Usage

-----

1. Edit ```bower.json``` and ```Gruntfile.coffee```.

2. Place your code in the ```src/``` directory.

3. ```npm start``` to begin and ```npm test``` to run tests.

Contributing

------------

Pull requests welcome.

Currently working on adding a test suite.

License

-------

The MIT License (MIT)

Copyright (c) 2013 Diwank Singh

Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in

all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN

THE SOFTWARE.