🎉 Nuxt Laravel Fortify and Sanctum Module

This Nuxt module seamlessly integrates Nuxt with Laravel Fortify and Sanctum in an SSR-friendly way, offering a rich set of authentication features. With this module, you can leverage Laravel Fortify's capabilities and perform both API Token and SPA cookie-based authentication.

🚀 Features

• Registration 📋
• Reset Passwords 🔄
• Email Verification 📧
• Update Profile Information ✏️
• Update Passwords 🔐
• Two-Factor Authentication 🔒

🛠️ Installation and Configuration

💡Notice: You need to install and setup Laravel Fortify, Laravel Sanctum, and fortify-sanctum package in your backend Laravel application. The fortify-sanctum package easily integrates Laravel Fortify's authentication features with Laravel Sanctum

Add nuxt-fortify module to your nuxt project

npx nuxi@latest module add nuxt-fortify

💻 Nuxt Configuration

Add the module to your Nuxt project by installing it and configuring it in nuxt.config.js.

// nuxt.config.js
export default {
  modules: [
    'nuxt-fortify',
  ],
  nuxtFortify: {
    baseUrl: 'http://localhost:3000/api',
    origin: 'http://localhost:3000',
    authMode: 'cookie',
    authHome: '/dashboard',
    endpoints: {
      csrf: '/sanctum/csrf-cookie',
      user: '/user',
      // other endpoints...
    },
    features: {
        registration: true,
        resetPasswords: true,
        twoFactorAuthentication: true,
      // other features...
    }
    // other configurations...
  }
}

📜 Configs

Key	Data Type	Default Value	Required
baseUrl	string	http://localhost:3000/api	Yes
authMode	string	cookie	Yes
loginRoute	endpoint	/login	No
authHome	endpoint	/home	No
cookieKey	string	XSRF-TOKEN	No
cookieHeader	string	X-XSRF-TOKEN	No
tokenStorageKey	string	API-TOKEN	No
endpoints.csrf	endpoint	/sanctum/csrf-cookie	No
endpoints.login	endpoint	/login	No
endpoints.logout	endpoint	/logout	No
endpoints.user	endpoint	/user	No
endpoints.tfa.enable	endpoint	/user/two-factor-authentication	No
endpoints.tfa.disable	endpoint	/user/two-factor-authentication	No
endpoints.tfa.code	endpoint	/user/two-factor-qr-code	No
endpoints.tfa.confirm	endpoint	/user/confirmed-two-factor-authentication	No
endpoints.tfa.recoveryCode	endpoint	/user/two-factor-recovery-codes	No
endpoints.tfa.challenge	endpoint	/two-factor-challenge	No
endpoints.register	endpoint	/register	No
endpoints.resetPassword	endpoint	/forgot-password	No
endpoints.updatePassword	endpoint	/reset-password	No
endpoints.confirmPassword	endpoint	/user/confirm-password	No
endpoints.resendEmailVerificationLink	endpoint	/email/verification-notification	No
intendedRedirect	boolean	true	No
features.registration	boolean	true	No
features.resetPasswords	boolean	true	No
features.emailVerification	boolean	true	No
features.updateProfileInformation	boolean	true	No
features.updatePasswords	boolean	true	No
features.twoFactorAuthentication	boolean	true	No
tfaRoute	endpoint	/two-factor-authentication	No
logLevel	number	1	No
origin	string	http://localhost:3000	Yes

🌐 Endpoints Configuration

Endpoint Key	Path	Request Method
csrf	/sanctum/csrf-cookie	POST
login	/login	POST
logout	/logout	POST
user	/user	POST
tfa.enable	/user/two-factor-authentication	POST
tfa.disable	/user/two-factor-authentication	DELETE
tfa.code	/user/two-factor-qr-code	GET
tfa.confirm	/user/confirmed-two-factor-authentication	POST
tfa.recoveryCode	/user/two-factor-recovery-codes	GET
tfa.challenge	/two-factor-challenge	POST
register	/register	POST
resetPassword	/forgot-password	POST
updatePassword	/reset-password	POST
confirmPassword	/user/confirm-password	POST
resendEmailVerificationLink	/email/verification-notification	POST

By following these steps and configurations, you'll have a fully integrated Nuxt application with Laravel Fortify and Sanctum, delivering a robust authentication solution. 🚀

🤝 Contributing

We welcome contributions to enhance this module. Here are the steps to contribute:

1. Fork the Repository: Create a fork of this repository on GitHub.

2. Clone Your Fork: Clone your forked repository to your local machine.

   git clone https://github.com/dev-charles15531/nuxt-forify.git
   cd nuxt-fortify

3. Create a Branch: Create a new branch for your feature or bug fix.

   git checkout -b feature-or-bugfix-name

4. Make Changes: Implement your feature or bug fix. Ensure your code follows the project's coding standards and passes all tests.

5. Commit Changes: Commit your changes with a clear and concise commit message.

   git add .
   git commit -m "Description of the feature or fix"

6. Push to Your Fork: Push your changes to your forked repository.

   git push origin feature-or-bugfix-name

7. Open a Pull Request: Open a pull request to the main repository. Provide a clear description of your changes and the problem or feature they address.

📝 Guidelines

• Follow the coding style used in the project.
• Write clear, concise commit messages.
• Ensure your code passes all tests and does not introduce new issues.
• Update documentation if your changes affect how the module is used or configured.

📧 Contact

If you have any questions or need help, feel free to open an issue or contact the maintainer of this repository.

Thank you for contributing! Your efforts are greatly appreciated. 🙌