Neoclassical Programming Multitude

    gpii-express-user

    1.0.1 • Public • Published

    gpii-express-user

    This package provides a series of server and client-side Fluid components to provide simple user management, including:

    1. Login, logout, and "current user" mechanisms.
    2. A "signup" mechanism to allow users to create accounts themselves. Accounts must be associated with a valid email to be complete the setup.
    3. A "forgot password" mechanism that sends the user a custom link via email that can be used to reset their password.

    Server Side Components

    The server side components are intended to be used with a gpii.express instance, and provide the REST API endpoints documented in src/docs/api.md. Before you can use the server side components, you must set up your database with the views included in src/views (see that directory for details).

    All user information stored by this package is meant to be backward compatible with CouchDB and express-couchUser. Accounts created using this package should be usable from either of those packages as well (in the case of CouchDB, the accounts would have to be written to the _user database). You should be able to safely copy or synchronize accounts between any two sites that use this package.

    When writing your own server-side components that depend on the current user's information, the current user will always be available as part of the request.session object. The user key may change depending on your configuration, by default the user is found at request.session._gpii_user.

    Client Side Components

    The client-side components provided here are intended to be used with the server-side API running on the same hostname and port that hosts the client-side content. No CORS, proxy, or other mechanism is provided to handle remote lookups.

    To use the client side components, set up your gpii.express instance with a static handler that will serve up the contents of src/js/client, and a gpii.express.hb instance that can serve up the required template content. It is recommended that you copy the sample template content found in src/templates to your template directory and customize based on your specific needs.

    For an example of both the server-side configuration and of serving up client-side content, check out the configuration of tests/js/launch-test-harness.js and tests/js/test-harness.js,

    Keywords

    none

    Install

    npm i gpii-express-user

    DownloadsWeekly Downloads

    25

    Version

    1.0.1

    License

    BSD-3-Clause

    Unpacked Size

    394 kB

    Total Files

    125

    Last publish

    Collaborators

    • amb26
    • the-t-in-rtf