Skip to content

Latest commit

 

History

History
266 lines (170 loc) · 5.93 KB

installation.md

File metadata and controls

266 lines (170 loc) · 5.93 KB

Installation

With LaraDumps, you can go right into debugging with minimal effort:

  1. Download the LaraDumps Desktop App.

  2. Install one of the LaraDumps PHP Packages according to your project stack.

  3. You may also install the Global LaraDumps package to make LaraDumps available in all projects in your computer.

  4. Start to Debuging!

Desktop App

LaraDumps Desktop App is available for Windows, Linux and macOS.

Proceed to the installation instructions according to your operating system:

:::tabs == macOS

Install via 🍺 Homebrew

  1. First, make sure Homebrew it is up to date. Run the following command:
brew update
  1. Then, add Homebrew LaraDumps tap. Run the following command:
brew tap laradumps/app
  1. Next, install the LaraDumps app. Run the following command:
brew install --cask laradumps/app/laradumps

Now, just open the App!

📝 NOTE: If you receive an "application damaged" error, read the section Running the app in this page.

To upgrade the app using Homebrew, run:

brew upgrade --cask laradumps

To uninstall the app using Homebrew, run:

brew uninstall laradumps/app/laradump

Disk image .dmg

Alternatively, you can download and install the LaraDumps App using its disk image.

Download latest version here

📝 NOTE: If you receive an "application damaged" error, read the section Running the app in this page.

Running the app

Once downloaded, open the file and drag & drop the LaraDumps app into your Applications folder.

Authorizing the app

The first time you open LaraDumps, you will receive an alert saying LaraDumps cannot be opened.

Don't worry! This is just because the app code is not signed with Apple. LaraDumps is not malicious software and all code is open-source.

To authorize LaraDumps to run, follow these steps:

1․ Click on the  (Apple logo) on the top menu.

2․ Go to System Preferences.

3․ Open the Security & Privacy tab.

4․ Click on the 🔒 (lock pad) and enter your password to authenticate.

5․ Click Open Anyway for LaraDumps.

6․ Once again, click Open when you are prompted about "This is an Internet Application".

Now, LaraDumps should run just fine!

== Linux

Linux

snapcraft

https://snapcraft.io/laradumps

sudo snap install laradumps

AppImage

Download latest version here

Download the latest application image LaraDumps-x.x.x.AppImage from GitHub.

Once downloaded, assign execution permission to the file:

Click on Properties, navigate to Permissions and click Allow to execute file as program. Now, open the AppImage file to proceed with the installation.

Alternatively, use the Terminal and run the command below:

chmod u+x ./LaraDumps-3.8.0.AppImage && ./LaraDumps-3.8.0.AppImage

(These steps might slightly change depending on your Linux distribution).

== Windows

Windows

Download latest version here

Once downloaded, open it and proceed with the installer.

:::

PHP Packages

Laravel Package

Requirements: PHP 8.1+ and Laravel 10+

1․ Install LaraDumps Package in your Laravel project using Composer.

Run the command:

composer require laradumps/laradumps ^3.0 --dev -W

2․ Now, configure LaraDumps. Run the command below:

php artisan ds:init $(pwd)

This command will generate a file called laradumps.yaml in the root of your project that looks like this:

::: warning This file is important for correct communication between the desktop app and the Laravel or PHP project. If your project_path is empty, you must manually add your project's $(pwd) to app.project_path :::

app:
  primary_host: 127.0.0.1
  secondary_host: host.docker.internal
  port: 9191
  workdir: /var/www/html/
  project_path: /your-project-path-here/
config:
  sleep: 0
  color_in_screen: false
  docker: false
observers:
  dump: false
  original_dump: false
  queries: false
  mail: false
  logs_applications: false
  logs_vendor: false
  logs_deprecated: false
  http: false
  jobs: false
  commands: false
  scheduled_commands: false
  gate: false
  cache: false

See full information in configuration options.

Agnostic PHP Framework

Requirements: PHP 8.1+

1․ Install LaraDumps Package in your PHP project using Composer.

Run the command:

composer require laradumps/laradumps-core ^2.0 --dev

2․ Now, configure LaraDumps. Run the command below:

vendor/bin/laradumps init $(pwd)

::: info Similar to Laravel step, a laradumps.yaml file will be generated here without the "observers" key, which is specific to Laravel. :::

app:
  primary_host: 127.0.0.1
  secondary_host: host.docker.internal
  port: 9191
  workdir: /var/www/html/
  project_path: /your-project-path-here/
config:
  sleep: 0
  color_in_screen: false
  docker: false

See full information in configuration options.

Global LaraDumps

Requirements: PHP 8.1+

1․ You can install the global LaraDumps via Composer.

composer global require laradumps/global-laradumps

How to install

global-laradumps install

How to uninstall

global-laradumps uninstall