Getting started
Install#
- npm
- Yarn
Determine integration level#
auth-nz was designed so that it can be integrated into any node.js web-app in a need for
an OAuth provider.
It reaches it's goal by exporting low level atoms as well as higher level abstractions.
You, as a developer, integrating auth-nz into your codebase need to identify the possible level
of integration.
This basically means that
- You can mount
auth-nzinto an existing connect like application andauth-nzwill register it's handlers on the app - You can reach a sort of balanced integration level by using
auth-nz's exported middleware functions and helpers to register the OAuth endpoints in your application yourself - Or you can use atoms if you can't use any of
auth-nz's abstractions
The more you go down with abstraction levels the more you will need to know about OAuth but the more flexible you can be.
Using a high abstraction level means you can integrate the package more easily but it also means you have less flexibility
with the integration and you will use the sensible defaults auth-nz makes.