Skip to content

Commit

Permalink
first draft
Browse files Browse the repository at this point in the history
  • Loading branch information
teddychan committed Dec 14, 2015
0 parents commit 0143af8
Show file tree
Hide file tree
Showing 15 changed files with 387 additions and 0 deletions.
22 changes: 22 additions & 0 deletions .editorconfig
@@ -0,0 +1,22 @@
# For more information about the properties used in
# this file, please see the EditorConfig documentation:
# http://editorconfig.org/

root = true

[*]
charset = utf-8
end_of_line = lf
indent_style = tab
insert_final_newline = true
trim_trailing_whitespace = true

[*.md]
trim_trailing_whitespace = false

[{*.yml,package.json}]
indent_size = 2
# The indent style for `*.yml` and `package.json` must be space
# http://www.yaml.org/spec/1.2/spec.html#id2777534
# https://github.com/npm/npm/issues/4718
indent_style = space
3 changes: 3 additions & 0 deletions .eslintrc
@@ -0,0 +1,3 @@
{
"extends": "aftership"
}
181 changes: 181 additions & 0 deletions .gitignore
@@ -0,0 +1,181 @@
# v1.0.5 2015-12-14
# ------------------------------------------------------------------------------
# for aftership-publish making use of https://github.com/inikulin/publish-please
# ------------------------------------------------------------------------------
.publishrc
.npmignore



# =========================== DO NOT touch below v1.0.4 2015-05-06 ===============================



# ------------------------------------------------------------------------------
# Add your custom excludes below
# ------------------------------------------------------------------------------


# =============== log ignore
builtAssets

/tmp/*
/builtAssets/*
*.log


# =========================== DO NOT touch below v1.0.3 ===============================


node_modules

# =============== RubyMine.gitignore
# =============== PhPStorm.gitignore
.idea


# =============== OSX.gitignore
.DS_Store
.AppleDouble
.LSOverride

# Thumbnails
._*

# =============== # Windows image file caches
Thumbs.db
ehthumbs.db

# Folder config file
Desktop.ini

# Recycle Bin used on file shares
$RECYCLE.BIN/

# Except the .htpassed
!.htpasswd
!.nodemonignore

npm-debug.log

dump.rdb







# FROM https://github.com/niftylettuce/node-email-templates/blob/master/.gitignore

# ------------------------------------------------------------------------------
# Common Node files and folders
# https://github.com/github/gitignore/blob/master/Node.gitignore
# ------------------------------------------------------------------------------

lib-cov
*.seed
*.log
*.csv
*.dat
*.out
*.pid
*.gz

pids
logs
results

node_modules
npm-debug.log


# ------------------------------------------------------------------------------
# Nodemon
# ------------------------------------------------------------------------------

.monitor


# ------------------------------------------------------------------------------
# JSHint
# ------------------------------------------------------------------------------

jshint


# ------------------------------------------------------------------------------
# Numerous always-ignore extensions
# ------------------------------------------------------------------------------

*.diff
*.err
*.orig
*.rej
*.swo
*.swp
*.vi
*~
*.sass-cache


# ------------------------------------------------------------------------------
# Files from other repository control systems
# ------------------------------------------------------------------------------

.hg
.svn
.CVS


# ------------------------------------------------------------------------------
# PHPStorm, RubyMine
# ------------------------------------------------------------------------------

.idea


# ------------------------------------------------------------------------------
# OS X and other IDE's folder attributes
# ------------------------------------------------------------------------------

.DS_Store
Thumbs.db
.cache
.project
.settings
.tmproj
*.esproj
nbproject
*.sublime-project
*.sublime-workspace


# ------------------------------------------------------------------------------
# Dreamweaver added files
# ------------------------------------------------------------------------------

_notes
dwsync.xml


# ------------------------------------------------------------------------------
# Komodo
# ------------------------------------------------------------------------------

*.komodoproject
.komodotools


# ------------------------------------------------------------------------------
# Custom files
# ------------------------------------------------------------------------------
_s3_bucket/
.fixtures/*
output_*.pdf
*_request.txt
*_response.txt
label_*.pdf
selfcheck.txt
credentials.json
coverage/
11 changes: 11 additions & 0 deletions .publishignore
@@ -0,0 +1,11 @@
.editorconfig
.eslintrc
.publishignore
.travis.yml
grunt
grunt-config
grunt-tasks
gulpfile.js
Gruntfile.js
log
test
8 changes: 8 additions & 0 deletions .travis.yml
@@ -0,0 +1,8 @@
language: node_js
node_js:
- "4.2"
install:
- npm install -g grunt-cli
- npm install
script:
- npm test
8 changes: 8 additions & 0 deletions CHANGELOG.md
@@ -0,0 +1,8 @@
## Release History

### PENDING
* Change that pending to release

### x.y.z (YYYY-MM-DD)
* Change 1
* Change 2
27 changes: 27 additions & 0 deletions Gruntfile.js
@@ -0,0 +1,27 @@
'use strict';

const loadGruntConfig = require('load-grunt-config');
const path = require('path');

module.exports = (grunt) => {
loadGruntConfig(grunt, {
pkg: grunt.file.readJSON('package.json'), // Loads grunt tasks defined in package.json
configPath: path.join(process.cwd(), 'grunt-config'), // path to task.js files, defaults to grunt dir
init: true, // auto grunt.initConfig

config: {
// additional config vars
},
loadGruntTasks: {
pattern: ['grunt-*', '@*/grunt-*']
}
});

// Tasks
grunt.registerTask('coverage', ['mocha_istanbul:coverage']);

grunt.registerTask('lint', ['eslint']);

// Default task
grunt.registerTask('default', []);
};
22 changes: 22 additions & 0 deletions LICENSE
@@ -0,0 +1,22 @@
Copyright (c) 2015 Postmen

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.
31 changes: 31 additions & 0 deletions README.md
@@ -0,0 +1,31 @@
# postmen

[![Build Status](https://travis-ci.org/Postmen/sdk-js.svg?branch=master)](https://travis-ci.org/Postmen/sdk-js)
[![codecov.io](https://codecov.io/github/Postmen/sdk-js/coverage.svg?branch=master)](https://codecov.io/github/Postmen/sdk-js?branch=master)
[![Dependency Status](https://gemnasium.com/Postmen/sdk-js.svg)](https://gemnasium.com/Postmen/sdk-js)

[![node](https://img.shields.io/node/v/postmen.svg)]()
[![npm](https://img.shields.io/npm/v/postmen.svg)]()
[![npm](https://img.shields.io/npm/dm/postmen.svg)]()
[![npm](https://img.shields.io/npm/l/postmen.svg)]()

Postmen SDK for JavaScript in the browser and Node.js

## Installation
```
npm install xxxx
```

## Examples
_(Coming soon)_

## Change Log
Please check [details here](CHANGELOG.md)

## Known Issues
- Some problems xxxxx. See #1264.

## License
Copyright (c) 2015 Postmen

Licensed under the MIT license.
13 changes: 13 additions & 0 deletions grunt-config/eslint.js
@@ -0,0 +1,13 @@
'use strict';

module.exports = {
options: {
configFile: '.eslintrc'
},
target: [
'**/*.js',
'!**/bower_components/**',
'!**/node_modules/**',
'!coverage/**'
]
};
9 changes: 9 additions & 0 deletions grunt-config/istanbul_check_coverage.js
@@ -0,0 +1,9 @@
'use strict';

module.exports = {
default: {
options: {
coverageFolder: 'coverage'
}
}
};
11 changes: 11 additions & 0 deletions grunt-config/mocha_istanbul.js
@@ -0,0 +1,11 @@
'use strict';

module.exports = {
coverage: {
src: ['test/**.js'],
options: {
coverage: true,
reporter: 'spec'
}
}
};
40 changes: 40 additions & 0 deletions package.json
@@ -0,0 +1,40 @@
{
"name": "postmen",
"description": "Postmen SDK for JavaScript in the browser and Node.js",
"version": "0.0.1",
"homepage": "https://github.com/Postmen/sdk-js",
"author": {
"name": "Postmen",
"email": "support@postmen.com"
},
"repository": {
"type": "git",
"url": "git://github.com/Postmen/sdk-js.git"
},
"bugs": {
"url": "https://github.com/Postmen/sdk-js/issues"
},
"main": "index.js",
"engines": {
"node": ">= 4.2"
},
"dependencies": {},
"devDependencies": {
"eslint": "^1.10.3",
"eslint-config-aftership": "^1.5.0",
"grunt": "^0.4.5",
"grunt-eslint": "^17.3.1",
"grunt-mocha-istanbul": "^3.0.1",
"istanbul": "^0.4.1",
"load-grunt-config": "^0.19.1",
"mocha": "^2.3.4"
},
"keywords": [
"postman",
"postman sdk",
"postmen",
"postmen sdk"
],
"license": "MIT",
"private": false
}

0 comments on commit 0143af8

Please sign in to comment.