diff --git a/.gitignore b/.gitignore index ea61c2f..3a28069 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,51 @@ # -# node-ff-tcrud ignore rules +# node-ff-assets git ignore rules # + +# Ignore npm files +node_modules +npm-debug.log + +# Ignore mocha test data +test/data + +# Ignore example data +example/node_modules +example/npm-debug.log +example/www_static/css/lib +example/www_static/js/lib + +# Ignore binary files +*.o +*.class +*.old +*.bak +*.backup +*.dat +*.data +*.gif +*.pdf +*.doc +*.db +*.ini + +# Ignore ~ backup files. +*~ + +# Ignore some eclipse files +.settings +.classpath +.project + +# Ignore netbeans directory +nbproject + +# Ignore mac finder files +.DS_Store + +# Ignore windows files. +# None (done by *.db and *.ini) + +# Ignore kde dolphin files +.directory + diff --git a/.jshintignore b/.jshintignore new file mode 100644 index 0000000..33493e1 --- /dev/null +++ b/.jshintignore @@ -0,0 +1,4 @@ +node_modules +example/node_modules +example/www_static +example/www_views \ No newline at end of file diff --git a/.jshintrc b/.jshintrc new file mode 100644 index 0000000..72cc948 --- /dev/null +++ b/.jshintrc @@ -0,0 +1,38 @@ +{ + "predef": [ + "before", + "after", + "it", + "describe", + "beforeEach", + "afterEach" + ], + "asi" : false, + "bitwise" : true, + "boss" : false, + "curly" : true, + "debug": false, + "devel": false, + "eqeqeq": true, + "evil": false, + "expr": true, + "forin": false, + "immed": true, + "latedef" : false, + "laxbreak": false, + "multistr": true, + "newcap": true, + "noarg": true, + "node" : true, + "noempty": false, + "nonew": true, + "onevar": false, + "plusplus": false, + "proto": true, + "regexp": false, + "strict": false, + "sub": false, + "trailing" : true, + "undef": true, + "unused": true +} diff --git a/README.md b/README.md new file mode 100644 index 0000000..aa20387 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +node-ff-tcrud +========= + +A Node.js library providing simple templated crud views. + +## Installation + + npm install node-ff-tcrud --save + +## Example Application + + There is a fully working express example application in the example folder. + todo + +## Usage + +### todo + +## Tests + + npm test + +## Contributing + +In lieu of a formal styleguide, take care to maintain the existing coding style. +Add unit tests for any new or changed functionality. Lint and test your code. + +## Release History + +### 0.1.x +* Initial release diff --git a/lib/node-ff-tcrud.js b/lib/node-ff-tcrud.js new file mode 100644 index 0000000..f571f68 --- /dev/null +++ b/lib/node-ff-tcrud.js @@ -0,0 +1,6 @@ +'use strict'; + +var assets = { +}; + +module.exports = assets; diff --git a/package.json b/package.json new file mode 100644 index 0000000..4899930 --- /dev/null +++ b/package.json @@ -0,0 +1,29 @@ +{ + "name": "node-ff-tcrud", + "version": "0.1.0", + "description": "Templated crud views.", + "main": "lib/node-ff-tcrud.js", + "scripts": { + "test": "npm run-script test-clean;npm run-script test-mocha", + "test-clean": "rm test/data/* -rf", + "test-mocha": "export JUNIT_REPORT_PATH=test/data/report.xml;export JUNIT_REPORT_STACK=1;node_modules/mocha/bin/mocha --reporter mocha-jenkins-reporter" + + }, + "author": "Willem (http://forwardfire.net/)", + "license": "BSD-2-Clause", + "repository": { + "type": "git", + "url": "https://bitbucket.org/im_ik/node-ff-tcrud.git" + }, + "dependencies": { + "fetch": "^0.3.6", + "fs-extra": "^0.16.3", + "minify": "^1.4.8", + "underscore": "^1.8.2" + }, + "devDependencies": { + "mocha": "^2.1.0", + "mocha-jenkins-reporter": "^0.1.4", + "mocha-jshint": "0.0.9" + } +}