GithubHelp home page GithubHelp logo

allaye / nub-auth Goto Github PK

View Code? Open in Web Editor NEW
1.0 1.0 0.0 28 KB

a very simple, minimalistic basic authentication tool, that will mostly serve as a middleware.

License: MIT License

JavaScript 100.00%

nub-auth's Introduction

nub-auth

npm version npm TypeScript compatible MIT Licence

a very simple, minimalistic basic authentication tool, that will mostly serve as a middleware.

How to Install and Installation information

This is a Node.js module available through the npm registry. Installation is done using the npm install command:

type below command in your terminal

npm install nub-auth

How to use it

The module interface exposes just a single function that expects a single argument

var express = require('express');
var nubAuth = require('nub-auth');
app = express();

app.use(['/v1'], nubAuth({
    challenge: true,
    users: { 'admins': 'admin', 'users': 'user', 'guest': 'guested' }
}));
app.get('/', function(req, res) {
    res.send('Hello World!');
});

app.get('/api', (req, res) => {
    res.send('Hello World welcome to API endpoints free !');
});

app.get("/v1", (req, res) => {
  res.send("Hello World welcome to API endpoints closed !");
});

app.listen(3000, function() {
    console.log('Example app listening on port 3000!');
});

argument users

You should pass an objects with users and password as key value pairs

argument chanllenge

By defaults the tools does not force the browser to display a basic chanllenge to the user, set this to true to force the browser to display a chanllenge. NB browsers like chromium edge will not display a chanellege, you have to set this on your browser settings.

nub-auth's People

Contributors

allaye avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.