https://github.com/potato4d/nuxt-basic-auth-module

Provide basic auth your Nuxt.js application
https://github.com/potato4d/nuxt-basic-auth-module

authentication basic-authentication javascript nuxt nuxt-module vue vuejs

Last synced: 15 days ago
JSON representation

Provide basic auth your Nuxt.js application

• Host: GitHub
• URL: https://github.com/potato4d/nuxt-basic-auth-module
• Owner: potato4d
• License: mit
• Created: 2018-10-04T05:42:29.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-04-15T11:44:02.000Z (7 months ago)
• Last Synced: 2024-04-15T23:46:27.678Z (7 months ago)
• Topics: authentication, basic-authentication, javascript, nuxt, nuxt-module, vue, vuejs
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/nuxt-basic-auth-module
• Size: 3.07 MB
• Stars: 311
• Watchers: 5
• Forks: 9
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Nuxt.js basic auth module

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)

[![donate: Patreon](https://img.shields.io/badge/donate-patreon-orange.svg?style=flat-square)](https://www.patreon.com/potato4d)

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square)](https://opensource.org/licenses/MIT)

[![NPM version](https://img.shields.io/npm/v/nuxt-basic-auth-module.svg?style=flat-square)](https://npmjs.com/package/nuxt-basic-auth-module)

[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors)

[![NPM downloads](https://img.shields.io/npm/dm/nuxt-basic-auth-module.svg?style=flat-square)](https://npmjs.com/package/nuxt-basic-auth-module)

[![codecov](https://codecov.io/gh/potato4d/nuxt-basic-auth-module/branch/master/graph/badge.svg)](https://codecov.io/gh/potato4d/nuxt-basic-auth-module)

![f2653ad0d131606c49edb3f605cbf547](https://user-images.githubusercontent.com/6993514/46481007-5af6b000-c82d-11e8-99b7-4cae88c22796.gif)

Provide basic authentication to your Nuxt.js application

[https://www.npmjs.com/package/nuxt-basic-auth-module](https://www.npmjs.com/package/nuxt-basic-auth-module)

## Installation

```bash

$ yarn add nuxt-basic-auth-module # or npm install

```

## Usage

Edit your nuxt.config.js

```js

export default {

  // ...

  modules: [

    'nuxt-basic-auth-module'

  ],

  basic: {

    name: 'AUTH USER NAME HERE',

    pass: 'AUTH PASSWORD HERE',

    enabled: process.env.BASIC_ENABLED === 'true' // require boolean value(nullable)

  },

  // ...

}

```

## Arguments

### enabled

- type: Boolean

- default: false

- required: false

Whether to activate this module.

If false, module registration is skipped.

### name

- type: String | Function

- required: true

Basic Auth user name.

The function passes req as an argument and must return the username as string.

### pass

- type: String | Function

- required: true

Basic Auth user password.

The function passes req as an argument and must return the password as string.

### message

- type: String,

- default: 'Please enter username and password'

- required: false

Message to be displayed during basic authentication.

### match

- type: String(regex literal) | Function

- required: false

The target path.

This allows you to set up basic authentication that is limited to routes that match regular expression literals or where the function returns true.

The function passes req as an argument.

## License

MIT

[https://github.com/potato4d/nuxt-basic-auth-module/blob/master/LICENSE](https://github.com/potato4d/nuxt-basic-auth-module/blob/master/LICENSE)

## Contributors

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    
Takuma HANATANI
💻 🚧 📖 🐛

    
Anthony Fu
💻

    
Jleroy
💻

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!