Skip to content

Latest commit

 

History

History
394 lines (311 loc) · 17.1 KB

README.md

File metadata and controls

394 lines (311 loc) · 17.1 KB
Raw

Material Dashboard 2 Laravel - Free

version license GitHub issues open GitHub issues closed

Frontend version: Material Dashboard v3.0.0. More info at https://www.creative-tim.com/product/material-dashboard

Speed up your web development with the Bootstrap 5 Admin Dashboard built for Laravel Framework 11.x and up.

If you want to get more features, go PRO with Material Dashboard 2 PRO Laravel.

Table of Contents

Prerequisites

If you don't already have an Apache local environment with PHP and MySQL, use one of the following links:

Also, you will need to install Composer: https://getcomposer.org/doc/00-intro.md
And Laravel: https://laravel.com/docs/11.x/installation

Installation

After initializing a fresh instance of Laravel (and making all the necessary configurations), install the preset using one of the provided methods:

Via composer

  1. Cd to your Laravel app
  2. Type in your terminal: composer require laravel/ui
  3. Install this preset via composer require laravel-frontend-presets/material-dashboard. No need to register the service provider. Laravel 11.x & up can auto detect the package.
  4. Run php artisan ui material command to install the Material preset. This will install all the necessary assets and also the custom auth views, it will also add the auth route in routes/web.php (NOTE: If you run this command several times, be sure to clean up the duplicate Auth entries in routes/web.php)
  5. In your terminal run composer dump-autoload
  6. Run php artisan migrate:fresh --seed to create basic users table

By using the archive

  1. In your application's root create a presets folder
  2. Download the archive of the repo and unzip it
  3. Copy and paste the downloaded folder in presets (created in step 2) and rename it to material
  4. Open composer.json file
  5. Add "LaravelFrontendPresets\\MaterialPreset\\": "presets/material/src" to autoload/psr-4 and to autoload-dev/psr-4
  6. Add LaravelFrontendPresets\MaterialPreset\MaterialPresetServiceProvider::class to config/app.php file
  7. Type in your terminal: composer require laravel/ui
  8. In your terminal run composer dump-autoload
  9. Run php artisan ui material command to install the Argon preset. This will install all the necessary assets and also the custom auth views, it will also add the auth route in routes/web.php (NOTE: If you run this command several times, be sure to clean up the duplicate Auth entries in routes/web.php)
  10. Add in your .env file the info for your database
  11. Run php artisan migrate:fresh --seed to create basic users table

Usage

Register a user or login with default user [email protected] and password secret from your database and start testing (make sure to run the migrations and seeders for these credentials to be available).

Besides the dashboard, the auth pages, the billing and table pages, there is also has an edit profile page. All the necessary files are installed out of the box and all the needed routes are added to routes/web.php. Keep in mind that all of the features can be viewed once you login using the credentials provided or by registering your own user.

Versions

HTML Laravel
HTML Laravel
Vue React
Vue React

Demo

Register Login Dashboard
Forgot Password Page Reset Password Page Profile Page
View More

Documentation

The documentation for the Material Dashboard Laravel is hosted at our website.

Login

If you are not logged in you can only access this page or the Sign Up page. The default url takes you to the login page where you use the default credentials [email protected] with the password secret. Logging in is possible only with already existing credentials. For this to work you should have run the migrations.

The App/Http/Controllers/SessionsController.php handles the logging in of an existing user.

       public function store()
    {
        $attributes = request()->validate([
            'email' => 'required|email',
            'password' => 'required'
        ]);

        if (! auth()->attempt($attributes)) {
            throw ValidationException::withMessages([
                'email' => 'Your provided credentials could not be verified.'
            ]);
        }

        session()->regenerate();

        return redirect('/dashboard');

    }

Register

You can register as a user by filling in the name, email and password for your account. You can do this by accessing the sign up page from the "Sign Up" button in the top navbar or by clicking the "Sign Up" button from the bottom of the log in form.. Another simple way is adding /sign-up in the url.

The App/Http/Controllers/RegisterController.php handles the registration of a new user.

   public function store(){

        $attributes = request()->validate([
            'name' => 'required|max:255|unique:users,name',
            'email' => 'required|email|max:255|unique:users,email',
            'password' => 'required|min:5|max:255',
        ]);

        $user = User::create($attributes);
        auth()->login($user);
        
        return redirect('/dashboard');
    }

Forgot Password

If a user forgets the account's password it is possible to reset the password. For this the user should click on the "here" under the login form.

The App/Http/Controllers/SessionsController.php takes care of sending an email to the user where he can reset the password afterwards.

       public function show(){

        request()->validate([
            'email' => 'required|email',
        ]);

        $status = Password::sendResetLink(
            request()->only('email')
        );
    
        return $status === Password::RESET_LINK_SENT
                    ? back()->with(['status' => __($status)])
                    : back()->withErrors(['email' => __($status)]);
    }

Reset Password

The user who forgot the password gets an email on the account's email address. The user can access the reset password page by clicking the button found in the email. The link for resetting the password is available for 12 hours. The user must add the email, the password and confirm the password for his password to be updated.

The App/Http/Controllers/SessionsController.php helps the user reset the password.

     public function update(){
        
        request()->validate([
            'token' => 'required',
            'email' => 'required|email',
            'password' => 'required|min:8|confirmed',
        ]); 
          
        $status = Password::reset(
            request()->only('email', 'password', 'password_confirmation', 'token'),
            function ($user, $password) {
                $user->forceFill([
                    'password' => ($password)
                ])->setRememberToken(Str::random(60));
    
                $user->save();
    
                event(new PasswordReset($user));
            }
        );
    
        return $status === Password::PASSWORD_RESET
                    ? redirect()->route('login')->with('status', __($status))
                    : back()->withErrors(['email' => [__($status)]]);
    }

User Profile

The profile can be accessed by a logged in user by clicking "User Profile" from the sidebar or adding /user-profile in the url. The user can add information like phone number, location, description or change the name and email.

The App/Http/Controllers/ProfileController.php handles the user's profile information.

    public function update()
    {
            
        $user = request()->user();
        $attributes = request()->validate([
            'email' => 'required|email|unique:users,email,'.$user->id,
            'name' => 'required',
            'phone' => 'required|max:10',
            'about' => 'required:max:150',
            'location' => 'required'
        ]);
        auth()->user()->update($attributes);
        return back()->withStatus('Profile successfully updated.');
    
}

Dashboard

You can access the dashboard either by using the "Dashboard" link in the left sidebar or by adding /dashboard in the url after logging in.

File Structure

+---app
|   +---Console
|   |       Kernel.php
|   +---Exceptions
|   |       Handler.php
|   +---Http
|   |   +---Controllers
|   |   |       Controller.php
|   |   |       DashboardController.php
|   |   |       ProfileController.php
|   |   |       SessionsController.php
|   |   |       RegisterController.php
|   |   |       
|   |   +---Middleware
|   |   |       Authenticate.php
|   |   |       EncryptCookies.php
|   |   |       PreventRequestsDuringMaintenance.php
|   |   |       RedirectIfAuthenticated.php
|   |   |       TrimStrings.php
|   |   |       TrustHosts.php
|   |   |       TrustProxies.php
|   |   |       VerifyCsrfToken.php
|   |   |
|   |    \---Kernel.php   
|   |   
|   +---Models
|   |        User.php
|   |     
|   \---Proviers
|          AppServiceProvider.php
|          AuthServiceProvider.php
|          BroadcastServiceProvider.php
|          EventServiceProvider.php
|          RouteServiceProvider.php
|   
+---database
|   \---seeders
|           DatabaseSeeder.php
|
\---resources
    |
    |
    \---views
        |   welcome.blade.php
        |   
        +---sessions
        |   |   create.blade.php
        |   |   
        |   \---passwords
        |           reset.blade.php
        |           verify.blade.php
        |           
        +---components
        |   |   layout.blade.php
        |   |   plugins.blade.php
        |   |   
        |   +---footers
        |   |       auth.blade.php
        |   |       guest.blade.php
        |   |       
        |   \---navbars
        |      |   sidebar.blade.php
        |      |   
        |      \---navs
        |             auth.blade.php
        |             guest.blade.php
        |              
        |           
        +---pages
        |   |   billing.blade.php
        |   |   notifications.blade.php
        |   |   profile.blade.php
        |   |   rtl.blade.php
        |   |   static-sign-in.blade.php
        |   |   static-sign-up.blade.php
        |   |   tables.blade.php
        |   |   virtual-reality.blade.php
        |   |  
        |   \---laravel-examples
        |           user-management.blade.php
        |           user-profile.blade.php
        |       
        +---dashboard
        |       index.blade.php
        | 
        +---errors
        |       401.blade.php
        |       403.blade.php
        |       404.blade.php
        |       405.blade.php
        |       419.blade.php
        |       429.blade.php
        |       500.blade.php
        |       503.blade.php
        |
        \---register
                create.blade.php

Browser Support

At present, we officially aim to support the last two versions of the following browsers:

Reporting Issues

We use GitHub Issues as the official bug tracker for the Material Dashboard. Here are some advices for our users that want to report an issue:

  1. Make sure that you are using the latest version of the Material Dashboard. Check the CHANGELOG from your dashboard on our website.
  2. Providing us reproducible steps for the issue will shorten the time it takes for it to be fixed.
  3. Some issues may be browser specific, so specifying in what browser you encountered the issue might help.

Licensing

Useful Links

Social Media

Creative Tim

Twitter: https://twitter.com/CreativeTim?ref=md2l-readme

Facebook: https://www.facebook.com/CreativeTim?ref=md2l-readme

Dribbble: https://dribbble.com/creativetim?ref=md2l-readme

Instagram: https://www.instagram.com/CreativeTimOfficial?ref=md2l-readme

Updivision:

Twitter: https://twitter.com/updivision?ref=md2l-readme

Facebook: https://www.facebook.com/updivision?ref=md2l-readme

Linkedin: https://www.linkedin.com/company/updivision?ref=md2l-readme

Updivision Blog: https://updivision.com/blog/?ref=md2l-readme

Credits