passport-local icon indicating copy to clipboard operation
passport-local copied to clipboard

clarify body-parser and LocalStrategy in readme

Open zrisher opened this issue 8 years ago • 3 comments

This PR adds a bit more detail to the readme around two major stumbling blocks for new users:

  • It's unclear where LocalStrategy in the first code example comes from
  • It's unclear that body-parser is required for fields to be available in req.body, where passport-local expects them.

I haven't seen anyone complaining about the former, but it was a bit confusing for me and easy enough to fix as part of this PR.

There's plenty of examples of people having issues with the latter:

  • https://github.com/jaredhanson/passport-local/issues/143
  • https://github.com/jaredhanson/passport-local/issues/129
  • http://stackoverflow.com/questions/18690354/passport-local-strategy-not-getting-called
  • http://stackoverflow.com/questions/24688142/nodejs-passport-authenticate-callback-not-being-called-with-no-errors

zrisher avatar Jan 18 '17 20:01 zrisher

Coverage Status

Coverage remained the same at 97.619% when pulling 3282b886b708a5f1faeac012f05737796656ccdc on zrisher:master into 3b9980f6467fd1203ecf8844fb017b5db2941606 on jaredhanson:master.

coveralls avatar Jan 18 '17 20:01 coveralls

👍 this is so needed, quick glance would be so helpful with this information!

bump @jaredhanson

gabrielcsapo avatar Aug 01 '17 01:08 gabrielcsapo

Merged in https://github.com/passport-next/passport-local

rwky avatar Jul 07 '18 14:07 rwky