Hull.js

Building the library

Checkout

git clone git@github.com:hull/hull-js.git

First, install gulp

sudo npm install -g gulp

Then switch to hull-js dir

cd hull-js
npm install
npm run build

The last command will start a static HTTP server (port 3001) that serves the files located in the root folder.

Developing

A boilerplate app is located in the app folder. Here's how to use it:

cp app/app.example.js app/app.js
gulp

Gulp will automatically start a Webpack server with live reloading. When it is done, you can point your browser to http://localhost:3001

Note: You must enter some keys in app/app.js. Find them by creating an Organization and a Platform at https://dashboard.hullapp.io.

Main gulp tasks

• build: Builds and executes the tests
• server (default): dist + starts a live reloading server for development

Releasing

• We use continuous integration.

• Checkout master

• git flow release start 'YOUR_RELEASE_VERSION_NAME'

• Merge your changes

• Bump YOUR_RELEASE_VERSION_NAME in bower.json and package.json

• Write Changelog

• Commit changes

• git flow release finish 'YOUR_RELEASE_VERSION_NAME'

Contributing

You're encouraged to submit pull requests, propose features and discuss issues.

If you want to submit code:

• Fork the project
• Write tests for your new feature or a test that reproduces a bug
• Implement your feature or make a bug fix
• Commit, push and make a pull request. Bonus points for topic branches.

License

MIT License. See LICENSE for details.

Copyright

Copyright (c) 2015 Hull, Inc.