Skip to content

The Nuxt Module for Authium's authentication wrapper

Notifications You must be signed in to change notification settings

Ezerium/authium-nuxt

Repository files navigation

Nuxt Module for Authium

npm version npm downloads License Nuxt

This module is a wrapper for Authium in Nuxt. It will allow you to request users to sign in and authorize via Authium, and you will receive the user's data based on the scopes you have added. Authium is an OAuth2.0 application, so developers will have less struggles making an account system for their own application.

Features

  • ⛰  Allow users to sign in to your application with the third-party application Authium.
  • 🚠  The information you receive is limited based on the scopes and encrypted.
  • 🌲  The callback component will receive the information and store it using cookies (recommended and default) or temporarily in a state (not recommended at all).

Quick Setup

Install the module to your Nuxt application with one command:

npx nuxi module add authium-nuxt

That's it! You can now use Authium-Nuxt in your Nuxt app ✨

Manual Installation

Install the module manually with these commands if the quick setup does not function properly. First run the command below:

npm install authium-nuxt

Open your nuxt.config.ts and add "authium-nuxt" to your modules. It should look like this:

export default defineNuxtConfig({
    modules: [/* ... */, 'authium-nuxt'],
})

Contribution

Local development
# Install dependencies
npm install

# Generate type stubs
npm run dev:prepare

# Develop with the playground
npm run dev

# Build the playground
npm run dev:build

# Run ESLint
npm run lint

# Run Vitest
npm run test
npm run test:watch

# Release new version
npm run release

About

The Nuxt Module for Authium's authentication wrapper

Resources

Stars

Watchers

Forks

Packages

No packages published