Skip to content

Latest commit

 

History

History
70 lines (45 loc) · 2.29 KB

README.md

File metadata and controls

70 lines (45 loc) · 2.29 KB
Raw

#MyAuth - A Laravel Authentication Bundle

This bundles is a basic wrapper for the current Authentication system built in Laravel. This bundle includes the basic user controller, login, signup, and dashboard views. It is very easy to use and customize.

Installation

To install the bundle, run the following command

php artisan bundle:install myauth

Next, we will tell the application to auto load the bundle. In your application/bundles.php file add the following line to the array

'myauth' => array('auto' => true),

Finally, we need to migrate the users table. Do this by running the command below (note: be sure that you have already run php artisan migrate:install)

php artisan migrate myauth

Testing it out

If everything was successful you should be able to navigate to your APPLICATION_HOST/login/ and you will see a plain email and password login.

Other routes that can be accessed in this bundle are:

  • APPLICATION_HOST/login/
  • APPLICATION_HOST/signup/
  • APPLICATION_HOST/logout/
  • APPLICATION_HOST/dashboard/ (only after authentication)

Configuration

Inside of the myauth/config/config.php file you can change the following code inside of the array to your desired URL routes. (example: instead of APPLICATION_HOST/signup/ perhaps you might want it to be APPLICATION_HOST/register/)

return array(

	// Routes for our authentication

	'login_route' => 'login',
	'logout_route' => 'logout',
	'signup_route' => 'signup',

	// Login the user and redirect them to this route
	'login_redirect' => '',
	
	'bundle_route' => $bundle['handles'],
);

Additionally you can specify the login_redirect route for the user to be redirected to when they are authenticated. (warning: Make sure to protect the login_redirect route with an authentication filter) Find out about the authentication filter here

Finally, if you wish to change the URL structure of the authentication routes you can add the handles parameter in the 'myauth' array element of the application/bundles.php file

'myauth' => array('auto' => true, 'handles' => 'auth'),

In this case your routes will now look as follows

  • APPLICATION_HOST/auth/login/
  • APPLICATION_HOST/auth/signup/
  • APPLICATION_HOST/auth/logout/
  • APPLICATION_HOST/auth/dashboard/