Skip to content

Latest commit

 

History

History
306 lines (239 loc) · 16 KB

README.md

File metadata and controls

306 lines (239 loc) · 16 KB
Raw

Soft UI Dashboard Laravel Livewire

version license GitHub issues open GitHub issues closed

Frontend version: Soft UI Dashboard v1.0.0. More info at https://www.creative-tim.com/product/soft-ui-dashboard-laravel-livewire/?ref=sudl-readme

Free Frontend Web App for Laravel with Livewire & Alpine.js

What happens when you combine Soft UI, one of the hottest design trends right now, and Laravel? We've partnered with UPDIVISION to create the ultimate design & development toolbox.

Soft UI Dashboard Laravel Livewire comes with dozens of handcrafted UI elements tailored for Bootstrap 5 and an out of the box Laravel backend. The Livewire integration allows you to build dynamic interfaces easier without leaving the comfort of your favourite framework. If you combine this even further with Alpine.js, you get the perfect combo for kickstarting your next project.

Ok, I`m hooked. So, what am I getting?

You're getting a lean, mean, app-building machine. Here is the blueprint:

  • 70 handcrafted UI components. From buttons and inputs to navbars and cards, everything is designed to create visually cohesive interfaces.
  • 7 example pages to get you started
  • fully-functional authentication system, register and user profile editing features built with Laravel
  • Livewire & Alpine.js integration

Free for personal and commercial projects

Whether you're working on a side project or delivering to a client, we've got you covered. Soft UI Dashboard Laravel Livewire is released under MIT license, so you can use it both for personal and commercial projects for free. All you need to do is start coding.

Detailed documentation and example pages

We also included detailed documentation for every component and feature so you can follow along. The pre-built example pages give you a quick glimpse of what Soft UI Dashboard Laravel Livewire has to offer so you can get started in no time.

If you want to get more features, go PRO with Soft UI Dashboard PRO Laravel Livewire.

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/10.x

Installation

  1. Unzip the downloaded archive
  2. Copy and paste soft-ui-dashboard-laravel-master folder in your projects folder. Rename the folder to your project's name
  3. In your terminal run composer install
  4. Copy .env.example to .env and updated the configurations (mainly the database configuration)
  5. In your terminal run php artisan key:generate
  6. Run php artisan migrate --seed to create the database tables and seed the roles and users tables
  7. Run php artisan storage:link to create the storage symlink (if you are using Vagrant with Homestead for development, remember to ssh into your virtual machine and run the command from there).

Usage

Register a user or login with default user admin@softui.com 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 Livewire
HTML Laravel

Demo

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

Documentation

The documentation for the Soft UI Dashboard Laravel Livewire 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 admin@softui.com 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\Livewire\Auth\Login handles the logging in of an existing user.

    public function login() {
        $credentials = $this->validate();
        if(auth()->attempt(['email' => $this->email, 'password' => $this->password], $this->remember_me)) {
            $user = User::where(["email" => $this->email])->first();
            auth()->login($user, $this->remember_me);
            return redirect()->intended('/dashboard-default');        
        }
        else{
            return $this->addError('email', trans('auth.failed')); 
        }
    }

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\Livewire\Auth\SignUp handles the registration of a new user.

    public function register() {
        $this->validate();
        $user = User::create([
            'name' => $this->name,
            'email' => $this->email,
            'password' => Hash::make($this->password)
        ]);
        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 or add /forgot-password in the url.

The App\Http\Livewire\Auth\ForgotPassword takes care of sending an email to the user where he can reset the password afterwards.

    public function recoverPassword() { 
        $this->validate();
        $user = User::where('email', $this->email)->first();
        if($user){
            $this->notify(new ResetPassword($user->id));
            $this->showSuccesNotification = true;
            $this->showFailureNotification = false;
        } else {
            $this->showFailureNotification = true;
        }
    }

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\Livewire\Auth\ResetPassword helps the user reset the password.

    public function resetPassword() {
        $this->validate();
        $existingUser = User::where('email', $this->email)->first();
        if($existingUser && $existingUser->id == $this->urlID) { 
            $existingUser->update([
                'password' => Hash::make($this->password) 
            ]);
            $this->showSuccesNotification = true;
            $this->showFailureNotification = false;
        } else {
            $this->showFailureNotification = true;
        }
    }

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\Livewire\UserProfile handles the user's profile information.

    public function save() {
        $this->validate();
        $this->user->save();
        $this->showSuccesNotification = true;
    }

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
│   ├── Kernel.php
│   ├── Livewire
│   │   ├── Auth
│   │   │   ├── ForgotPassword.php
│   │   │   ├── Login.php
│   │   │   ├── Logout.php
│   │   │   ├── ResetPassword.php
│   │   │   └── SignUp.php
│   │   ├── Billing.php
│   │   ├── Dashboard.php
│   │   ├── LaravelExamples
│   │   │   ├── UserManagement.php
│   │   │   └── UserProfile.php
│   │   ├── Profile.php
│   │   ├── Rtl.php
│   │   ├── StaticSignIn.php
│   │   ├── StaticSignUp.php
│   │   └── Tables.php
│   └── Middleware
│       ├── Authenticate.php
│       ├── EncryptCookies.php
│       ├── PreventRequestsDuringMaintenance.php
│       ├── RedirectIfAuthenticated.php
│       ├── TrimStrings.php
│       ├── TrustHosts.php
│       ├── TrustProxies.php
│       └── VerifyCsrfToken.php
├── Models
│   └── User.php
├── Notifications
│   └── ResetPassword.php
├── Providers
│   ├── AppServiceProvider.php
│   ├── AuthServiceProvider.php
│   ├── BroadcastServiceProvider.php
│   ├── EventServiceProvider.php
│   └── RouteServiceProvider.php
└── View
    └── Components
        └── Layouts
            ├── App.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 Soft UI 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 Soft UI 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=sudl-readme

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

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

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

Updivision:

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

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

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

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

Credits