Initial commit to Koach

Author: arpit-systango

.babelrc

@@ -0,0 +1,6 @@
+{
+  "presets": [
+    "es2015-node5",
+    "stage-0"
+  ]
+}

.editorconfig

@@ -0,0 +1,30 @@
+# http://editorconfig.org
+
+# A special property that should be specified at the top of the file outside of
+# any sections. Set to true to stop .editor config file search on current file
+root = true
+
+[*]
+# Indentation style
+# Possible values - tab, space
+indent_style = space
+
+# Indentation size in single-spaced characters
+# Possible values - an integer, tab
+indent_size = 2
+
+# Line ending file format
+# Possible values - lf, crlf, cr
+end_of_line = lf
+
+# File character encoding
+# Possible values - latin1, utf-8, utf-16be, utf-16le
+charset = utf-8
+
+# Denotes whether to trim whitespace at the end of lines
+# Possible values - true, false
+trim_trailing_whitespace = true
+
+# Denotes whether file should end with a newline
+# Possible values - true, false
+insert_final_newline = true

.eslintrc.json

@@ -0,0 +1,8 @@
+{
+  "parser": "babel-eslint",
+  "extends": "standard",
+  "env": {
+    "node": true,
+    "mocha": true
+  }
+}

.gitignore

@@ -0,0 +1,56 @@
+# Created by https://www.gitignore.io/api/node,sublimetext
+
+### Node ###
+# Logs
+logs
+*.log
+npm-debug.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directory
+node_modules
+
+# Optional npm cache directory
+.npm
+
+# Optional REPL history
+.node_repl_history
+
+
+### SublimeText ###
+# cache files for sublime text
+*.tmlanguage.cache
+*.tmPreferences.cache
+*.stTheme.cache
+
+# workspace files are user-specific
+*.sublime-workspace
+
+# project files should be checked into the repository, unless a significant
+# proportion of contributors will probably not be using SublimeText
+*.sublime-project
+
+# sftp configuration file
+sftp-config.json
+
+#Documentation
+docs

LICENSE

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright (c) 2017 Arpit Khandelwal <arpit@systango.com>
+
+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.

README.md

@@ -0,0 +1,72 @@
+#KOACH
+
+Production ready boilerplate for building APIs with [koa2] and mongodb.
+
+This project covers basic necessities of most APIs.
+* Authentication (passport & jwt)
+* Database (mongoose)
+* Testing (mocha)
+* Doc generation with apidoc
+* linting using standard
+
+##Requirements
+* node > v7.8.0
+
+##Installation
+```bash
+git clone 
+```
+
+##Features
+* [koa2](https://github.com/koajs/koa)
+* [koa-router](https://github.com/alexmingoia/koa-router)
+* [koa-bodyparser](https://github.com/koajs/bodyparser)
+* [koa-generic-session](https://github.com/koajs/generic-session)
+* [koa-logger](https://github.com/koajs/logger)
+* [MongoDB](http://mongodb.org/)
+* [Mongoose](http://mongoosejs.com/)
+* [Passport](http://passportjs.org/)
+* [Nodemon](http://nodemon.io/)
+* [Mocha](https://mochajs.org/)
+* [apidoc](http://apidocjs.com/)
+* [Babel](https://github.com/babel/babel)
+* [ESLint](http://eslint.org/)
+
+##Structure
+```
+├── bin
+│   └── server.js            # Bootstrapping and entry point
+├── config                   # Server configuration settings
+│   ├── env                  # Environment specific config
+│   │   ├── common.js
+│   │   ├── development.js
+│   │   ├── production.js
+│   │   └── test.js
+│   ├── index.js             # Config entrypoint - exports config according to envionrment and commons
+│   └── passport.js          # Passportjs config of strategies
+├── src                      # Source code
+│   ├── modules
+│   │   ├── controller.js    # Module-specific controllers
+│   │   └── router.js        # Router definitions for module
+│   ├── models               # Mongoose models
+│   └── middleware           # Custom middleware
+│       └── validators       # Validation middleware
+└── test                     # Unit tests
+```
+
+##Usage
+* `npm start` Start server on live mode
+* `npm run dev` Start server on dev mode with nodemon
+* `npm run docs` Generate API documentation
+* `npm test` Run mocha tests
+
+##Documentation
+API documentation is written inline and generated by [apidoc](http://apidocjs.com/).
+
+Visit `http://localhost:3000/docs/` to view docs
+
+##Contributors
+Systango, Arpit Khandelwal
+
+##License
+MIT

bin/server.js

@@ -0,0 +1,38 @@
+import Koa from 'koa'
+import bodyParser from 'koa-bodyparser'
+import convert from 'koa-convert'
+import logger from 'koa-logger'
+import mongoose from 'mongoose'
+import session from 'koa-generic-session'
+import passport from 'koa-passport'
+import mount from 'koa-mount'
+import serve from 'koa-static'
+
+import config from '../config'
+import { errorMiddleware } from '../src/middleware'
+
+const app = new Koa()
+app.keys = [config.session]
+
+mongoose.Promise = global.Promise
+mongoose.connect(config.database)
+
+app.use(convert(logger()))
+app.use(bodyParser())
+app.use(session())
+app.use(errorMiddleware())
+
+app.use(convert(mount('/docs', serve(`${process.cwd()}/docs`))))
+
+require('../config/passport')
+app.use(passport.initialize())
+app.use(passport.session())
+
+const modules = require('../src/modules')
+modules(app)
+
+app.listen(config.port, () => {
+  console.log(`Server started on ${config.port}`)
+})
+
+export default app

config/env/common.js

@@ -0,0 +1,3 @@
+export default {
+  port: process.env.PORT || 3000
+}

config/env/development.js

@@ -0,0 +1,5 @@
+export default {
+  session: 'secret-boilerplate-token',
+  token: 'secret-jwt-token',
+  database: 'mongodb://localhost:27017/koach-dev'
+}

config/env/production.js

@@ -0,0 +1,5 @@
+export default {
+  session: 'secret-boilerplate-token',
+  token: 'secret-jwt-token',
+  database: 'mongodb://localhost:27017/koach-prod'
+}