chore(scaffolding): initial setup

Author: zeropaper

.editorconfig

@@ -0,0 +1,10 @@
+# EditorConfig is awesome: http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[{*.js,*.less,*.json,*.html}]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true

.gitignore

@@ -0,0 +1,2 @@
+node_modules
+doc

.jshintrc

@@ -0,0 +1,21 @@
+{
+  "globals": {
+    "browser": false,
+    "element": false,
+    "by": false,
+    "describe": false,
+    "xdescribe": false,
+    "ddescribe": false,
+    "it": false,
+    "xit": false,
+    "expect": false,
+    "beforeEach": false,
+    "afterEach": false,
+    "runs": false,
+    "waitsFor": false
+  },
+  "node": true,
+  "browser": true,
+  "indent": 2,
+  "strict": true
+}

Gruntfile.js

@@ -0,0 +1,60 @@
+/* jshint node: true */
+'use strict';
+
+module.exports = function(grunt) {
+  require('load-grunt-tasks')(grunt);
+  require('time-grunt')(grunt);
+
+  var pkg = require('./package.json');
+  var config = {};
+
+  config.grunt = grunt;
+  config.pkg = pkg;
+
+  grunt.initConfig({
+    pkg:              pkg,
+
+    browserify:       require('./grunt/config/browserify')(config),
+
+    clean:            ['doc', 'dist', '.tmp'],
+
+    copy:             require('./grunt/config/copy')(config),
+
+    jasmine_node:     require('./grunt/config/jasmine_node')(config),
+
+    jsdoc:            require('./grunt/config/jsdoc')(config),
+
+    jshint:           require('./grunt/config/jshint')(config),
+
+    karma:            require('./grunt/config/karma')(config),
+
+    watch:            require('./grunt/config/watch')(config),
+  });
+
+  grunt.registerTask('build', function(target) {
+    target = target || 'prod';
+
+    var tasks = [
+      'jshint',
+      'clean',
+      'jsdoc',
+      'copy',
+      'browserify'
+    ];
+
+    grunt.task.run(tasks);
+  });
+
+  grunt.registerTask('auto-build', function(target) {
+    target = target || 'prod';
+
+    var tasks = [
+      'build',
+      'watch'
+    ];
+
+    grunt.task.run(tasks);
+  });
+
+  grunt.registerTask('default', ['build']);
+};

README.md

@@ -1,4 +1,48 @@
-camunda-bpm-sdk-js
-==================
+# camunda-bpm-sdk-js
 
-Javascript client library for camunda BPM
+Javascript client library for [camunda BPM](https://github.com/camunda/camunda-bpm-platform)
+
+## Features
+
+
+## Installation
+
+
+## Usage
+
+
+### In browsers
+
+```HTML
+<script type="text/javascript" src="dist/camunda-bpm-sdk.js"></script>
+<script type="text/javascript">
+  // TODO
+</script>
+```
+
+### With node.js
+
+```js
+var cam = require('camunda-bpm-sdk-js');
+// TODO
+```
+
+## Development
+
+```bash
+npm install
+```
+
+```bash
+grunt auto-build
+```
+
+
+## License
+
+[Apache License 2.0](./LICENSE)
+
+## Authors
+
+ - [Daniel _meyerdan_ Meyer](https://github.com/meyerdan) - [@meyerdan](http://twitter.com/meyerdan)
+ - [Valentin _zeropaper_ Vago](https://github.com/zeropaper) - [@zeropaper](http://twitter.com/zeropaper)

grunt/config/browserify.js

@@ -0,0 +1,19 @@
+module.exports = function(config) {
+  config = config || {};
+
+  return {
+    options: {
+      livereload: false
+    },
+
+    sources: {
+      files: [
+        'src/**/*.js'
+      ],
+      tasks: [
+        'newer:jshint',
+        'browserify'
+      ]
+    }
+  };
+};

grunt/config/copy.js

@@ -0,0 +1,18 @@
+module.exports = function() {
+  return {
+    options: {},
+    assets: {
+      files: [
+        // {
+        //   expand: true,
+        //   cwd: 'client',
+        //   src: [
+        //     '*.{ico,txt}',
+        //     'index.html'
+        //   ],
+        //   dest: 'dist/'
+        // }
+      ]
+    }
+  };
+};

grunt/config/jasmine_node.js

@@ -0,0 +1,20 @@
+module.exports = function() {
+  return {
+    options: {
+      forceExit: true,
+      match: '.',
+      matchall: false,
+      extensions: 'js',
+      specNameMatcher: 'Spec',
+      captureExceptions: true,
+      verbose: true,
+      junitreport: {
+        report: false,
+        savePath : "./test/reports/",
+        useDotNotation: true,
+        consolidate: true
+      }
+    },
+    unit: ['test/jasmine_node/**/*Spec.js']
+  };
+};

grunt/config/jsdoc.js

@@ -0,0 +1,21 @@
+module.exports = function() {
+  return {
+    options: {
+      plugins: [
+        'plugins/markdown'
+      ],
+      markdown: {
+        parser: 'gfm'
+      }
+    },
+    scripts: {
+      options: {
+        destination: 'doc'
+      },
+      src: [
+        'README.md',
+        'src/**/*.js'
+      ]
+    }
+  };
+};

grunt/config/jshint.js

@@ -0,0 +1,21 @@
+module.exports = function() {
+  return {
+    options: {
+      jshintrc: true
+    },
+    scripts: {
+      files: {
+        src: [
+          'src/**/*.js'
+        ]
+      }
+    },
+    test: {
+      files: {
+        src: [
+          'test/**/*.js'
+        ]
+      }
+    }
+  };
+};

grunt/config/karma.js

@@ -0,0 +1,36 @@
+module.exports = function() {
+  return {
+    options: {
+      singleRun: true,
+      autoWatch: false,
+
+      frameworks: ['jasmine'],
+
+      files: [
+        'node_modules/karma-jasmine/lib/jasmine.js',
+        'node_modules/karma-jasmine/lib/adapter.js',
+
+        {pattern: 'test/karma/**/*Spec.js', included: true},
+        {pattern: 'dist/**/*.js', included: false},
+
+        'test/karma/main.js'
+      ],
+      browsers: [
+        // 'Chrome',
+        // 'Firefox',
+        'PhantomJS'
+      ]
+    },
+
+    integration: {
+      options: {}
+    },
+
+    dev: {
+      options: {
+        singleRun: false,
+        autoWatch: true
+      }
+    }
+  }
+};

grunt/config/watch.js

@@ -0,0 +1,19 @@
+module.exports = function(config) {
+  config = config || {};
+
+  return {
+    options: {
+      livereload: false
+    },
+
+    sources: {
+      files: [
+        'src/**/*.js'
+      ],
+      tasks: [
+        'newer:jshint',
+        'browserify'
+      ]
+    }
+  };
+};

package.json

@@ -0,0 +1,41 @@
+{
+  "name": "camunda-bpm-sdk-js",
+  "version": "0.0.1",
+  "description": "Javascript client library for camunda BPM",
+  "main": "src/index.js",
+  "scripts": {
+    "test": "node_modules/.bin/jasmine_node"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/camunda/camunda-bpm-sdk-js.git"
+  },
+  "keywords": [
+    "camunda-bpm",
+    "sdk"
+  ],
+  "author": "Daniel Meyer <[email protected]>",
+  "contributors": [
+    "Valentin Vago <[email protected]>"
+  ],
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/camunda/camunda-bpm-sdk-js/issues"
+  },
+  "homepage": "https://github.com/camunda/camunda-bpm-sdk-js",
+  "dependencies": {},
+  "devDependencies": {
+    "browserify": "~4.1.10",
+    "grunt": "~0.4.5",
+    "grunt-browserify": "~2.1.0",
+    "grunt-contrib-clean": "~0.5.0",
+    "grunt-jsdoc": "~0.5.4",
+    "grunt-karma": "~0.8.3",
+    "grunt-newer": "~0.7.0",
+    "jasmine-node": "~1.14.3",
+    "karma": "~0.12.16",
+    "karma-jasmine": "~0.1.5",
+    "load-grunt-tasks": "~0.5.0",
+    "time-grunt": "~0.3.2"
+  }
+}

src/index.js

@@ -0,0 +1,19 @@
+/**
+ * @module  camunda-bpm-sdk-js
+ */
+
+/**
+ * Entry point of the module
+ *
+ * @param  {Object} config        - used to provide necessary configuration
+ * @param  {String} config.engine - ...
+ * @param  {String} config.app    - ...
+ *
+ * @return {Object}               - ...
+ */
+var cam = function(config) {
+  config = config || {};
+
+};
+
+module.exports = cam;

test/jasmine_node/nodeEnvSpec.js

@@ -0,0 +1,3 @@
+describe('The node.js usage', function() {
+
+});

test/karma/browserEnvSpec.js

@@ -0,0 +1,3 @@
+describe('The browser usage', function() {
+
+});

test/karma/main.js

@@ -0,0 +1,3 @@
+(function(root) {
+  //
+}(this));