adrianobel / koa2-api-boilerplate Goto Github PK

So this boilerplate is absolutely fantastic...
Just wondering if you could stick in the most basic examples of a resource route showing an authenticated route and a non-authenticated route.

/home
/dashboard     [auth required]

it would be super helpful for beginners (like me).
thanks!

Would there be a lot of work to use ES2016 with this boilerplate? Or is just matter of replacing babel-preset-es2015-node6 with babel-preset-es2016 ?

Here are a few things I'm thinking about implementing for V3 of this boilerplate.

• Replace JSONDoc with API Blueprint + Aglio for documentation
• Use Dredd for Documentation Validation / testing
• Docker

Going through a few options regarding docs.

I'm thinking an inline solution (jsdoc style) instead of having to maintain a separate mark up file would be best.

What do you think about http://swagger.io/ integration?

Hi there, what do you think about using https://www.npmjs.com/package/bcrypt-as-promised instead of bcrypt ?
It's give opportunity for using async/await syntax.

koa deprecated Support for generators will be removed in v3. See the documentation for examples of how to convert old middleware https://github.com/koajs/koa/blob/master/docs/migration.md bin/server.js:59:5
(node:7253) DeprecationWarning: open() is deprecated in mongoose >= 4.11.0, use openUri() instead, or set the useMongoClient option if using connect() or createConnection()

First of all thank you very much for this boilerplate, it's great work and has been tremendously helpful for me to gain an understanding of koa2 and async/await.

I'm struggling to understand the purpose of these pieces of code in /modules/index.js:
const lastHandler = handlers.pop();
return await lastHandler(ctx)

From what I can tell this is so you can check if it is the lasthandler by checking if next exists, but why would you need to do this?

Just pulled project and tested it a bit, but what to do with command npm test? As its fails mostly because of ctx input? In a way of: TypeError: Cannot read property 'body' of undefined ?

Hi,

Thanks for the amazing project!
I am using the boilerplate to setup my api and I want to allow login using Fb and Google. The login functionality using local strategy works fine. However, I am unable to integrate it with Fb, Github strategies.

When I access the route http://localhost:3000/auth/github, I get a 404 with the given code:

config/passport.js

passport.use('github', new Strategy({
  clientID: '<client-id>',
  clientSecret: '<secret-token>',
  callbackURL: 'http://localhost:3000/auth/github/callback'
}, async (accessToken, refreshToken, profile, done) => {
    let user = profile
    done(null, user)
}))

controller.js

export async function authUserPre(ctx, next) {
   return passport.authenticate('github')
 }

 export async function authUser(ctx, next) {
   return passport.authenticate({
     successRedirect: '/',
     failureRedirect: '/'
   })
 }

routes.js

export const baseUrl = '/auth'
export default [
  {
    method: 'GET',
    route: '/github',
    handlers: [
      auth.authUserPre
    ]
  },
  {
    method: 'GET',
    route: '/github/callback',
    handlers: [
      auth.authUser
    ]
  }
]

I've been following this project as a good baseline for testing my Koa2 API, and was wondering what you all think about using async/await with Mocha/Chai/Supertest.

It seems fitting considering the entire API uses async/await as well.