adonis-auth-builder

Adonis Auth Builder.

Adonis auth scaffold offers you painless authentication

Spend those minutes you'd use in setting up authentication doing awesome stuff within your app.

Index

• Introduction
• Installation
• Getting Started

Introduction

Directory Structure

app
└── Controllers
    └── HTTP
        ├── AuthController.js
        ├── ApiAuthController.js
config
    ├── adonis-auth-builder.js
resources
    └── views
        └── auth
            └── emails
                ├── password.edge
                ├── welcome-mail.edge

start
    ├── authEvents.js
    ├── authRoutes.js
    ├── apiAuthRoutes.js

About Adonis Auth Builder.

Adonis Auth Scaffold is a CLI utility that gives you a functional authentication system in Adonis.js within seconds.

Getting Started

Installation

Install adonis-auth-builder by running the below command.

NPM

npm install adonis-auth-builder --save-dev
npm install @adonisjs/mail  @adonisjs/validator

Yarn

yarn add adonis-auth-builder --save-dev
yarn add @adonisjs/mail  @adonisjs/validator

Register providers.

The adonis-auth-builder provider must be registered as an aceProvider. We are running CLI commands after all!

const aceProviders = [
  "adonis-auth-builder/providers/AdonisAuthBuilderProvider",
];

Also add providers for the newly installed dependencies.

const providers = [
  "@adonisjs/validator/providers/ValidatorProvider",
  "@adonisjs/mail/providers/MailProvider",
];

Generating auth scaffold.

Please run the below command to scaffold authentication.

adonis make:auth

A prompt to choose between generating code for a RESTful Api or a HTTP client allows you customize the generated files for your specific use case. Alternative versions of this command involves passing either the --api-only or --http-only flags.

To generate auth files for a REST Api, you may run:

adonis make:auth --api-only

Events

Please add the following line at the beginning of start/events.js.

require("./authEvents");

Migrations

Run the following command to run startup migrations. Please remember to add the status column to your User migration.

adonis migration:run

Author

Emmanuel Ogbiyoyo [e-mail]

Contributing

Contributions are welcome! Check out the issues or the PRs, and make your own if you want something that you don't see there.

License

GPLv3.0