Getting Started

System Requirements

Deprixa Plus requires a standard LEMP or LAMP stack. The following are minimum and recommended specifications.

Installation on Local Server (MAMP / XAMPP)

Use this guide to run Deprixa Plus on your own computer for development or testing. Node.js is required on local machines to compile the frontend assets.

1. 1

   Place the Files

   Extract the downloaded ZIP into your local web server's document root:

   • MAMP (macOS): /Applications/MAMP/htdocs/deprixa-plus/
   • XAMPP (Windows): C:\xampp\htdocs\deprixa-plus\
   • XAMPP (macOS): /Applications/XAMPP/htdocs/deprixa-plus/

   The file artisan must be at the root of this folder.

2. 2

   Start MAMP / XAMPP

   Open MAMP or XAMPP and start both the Apache (or Nginx) and MySQL services. In MAMP, go to MAMP → Preferences → PHP and confirm PHP 8.2 or 8.3 is selected. In XAMPP, use the Control Panel to start Apache and MySQL.

   Create an empty database for Deprixa Plus using phpMyAdmin (accessible at http://localhost/phpmyadmin by default).

3. 3

   Install PHP Dependencies (Composer)

   Open a terminal, navigate to the project folder, and run Composer. On MAMP you may need to use MAMP's PHP binary explicitly:

   bash — MAMP (macOS) Copy

   cd /Applications/MAMP/htdocs/deprixa-plus
   /Applications/MAMP/bin/php/php8.3.x/bin/php /usr/local/bin/composer install

   bash — XAMPP (Windows, Command Prompt) Copy

   cd C:\xampp\htdocs\deprixa-plus
   composer install

   If Composer is not in your PATH, download it from getcomposer.org and run it as php composer.phar install.

4. 4

   Configure the Environment File

   bash Copy

   cp .env.example .env
   php artisan key:generate

   Open .env and set APP_URL=http://localhost:8888/deprixa-plus/public (adjust port to match MAMP's Apache port — default is 8888). Set APP_ENV=local and APP_DEBUG=true for local development.

5. 5

   Install Node.js Dependencies and Build Frontend

   This step is required on local machines. It installs ~500 MB of packages into node_modules/ and compiles the React/TypeScript frontend into public/build/. The node_modules/ folder is only needed on the machine doing the build — it is never uploaded to production.

   bash Copy

   npm install
   npm run build

   For active development (hot module replacement), use npm run dev instead of npm run build. This starts Vite's dev server which automatically refreshes the browser on file changes.

6. 6

   Create Storage Symlink

   bash Copy

   php artisan storage:link

7. 7

   Run the Installation Wizard

   Open your browser and go to your local URL, for example:

   • MAMP: http://localhost:8888/deprixa-plus/public/install
   • XAMPP: http://localhost/deprixa-plus/public/install

   Follow the 5-step wizard. When entering database credentials in Step 3, use 127.0.0.1 as the host, 3306 as the port, and the username/password you configured in MAMP/XAMPP (default is often root / root or root / empty).

Installation Steps

Deprixa Plus uses a web-based installation wizard. You prepare the server via the command line (steps 1–6), then complete the setup through your browser (step 7). Each step must complete successfully before proceeding to the next.

1. 1

   Extract the Source Code

   Download the ZIP file from your Envato purchase page (CodeCanyon). Log in to your Envato account, go to your purchases, find Deprixa Plus, and click Download → All files & documentation.

   Extract the downloaded ZIP to your web server directory. For example:

   • Linux VPS/production: /var/www/html/deprixa-plus
   • MAMP (macOS): /Applications/MAMP/htdocs/deprixa-plus
   • XAMPP (Windows/macOS): C:\xampp\htdocs\deprixa-plus

   Upload the contents of the ZIP so that the artisan file is directly at the root of your chosen directory (e.g., /var/www/html/deprixa-plus/artisan).

2. 2

   Install PHP Dependencies

   Run Composer to install all backend packages. Use --no-dev in production to exclude development-only packages and --optimize-autoloader for a performance-optimized class map.

   bash Copy

   composer install --no-dev --optimize-autoloader

3. 3

   Configure the Environment File

   Copy the example environment file and generate a new application encryption key. The key must be generated before running any other Artisan commands.

   bash Copy

   cp .env.example .env
   php artisan key:generate

   Open .env with your preferred editor and fill in at minimum the APP_URL and mail settings. The database credentials will be configured through the wizard in step 7.

4. 4

   Build Frontend Assets

   Pre-built assets included in the ZIP

   The distribution ZIP already includes the compiled frontend in public/build/. If that folder exists and contains a manifest.json, you can skip this step entirely — Node.js and npm are NOT required on the production server. Only run this step if you modified the frontend source code or if the public/build/ folder is missing.

   If you need to rebuild the frontend (e.g., after modifying React source files), install Node dependencies and compile. Always use npm run build on production (not dev):

   bash Copy

   npm install
   npm run build

   The node_modules/ folder (~500 MB) is only needed during the build — do not upload it to production. Only the compiled output in public/build/ needs to be present on the server.

5. 5

   Configure Nginx Web Server

   Point your Nginx server block to the /public directory. Below is a complete, production-ready configuration:

   nginx Copy

   server {
       listen 80;
       listen [::]:80;
       server_name yourdomain.com www.yourdomain.com;
       root /var/www/deprixa-plus/public;
   
       add_header X-Frame-Options "SAMEORIGIN";
       add_header X-Content-Type-Options "nosniff";
   
       index index.php;
   
       charset utf-8;
   
       location / {
           try_files $uri $uri/ /index.php?$query_string;
       }
   
       location = /favicon.ico { access_log off; log_not_found off; }
       location = /robots.txt  { access_log off; log_not_found off; }
   
       error_page 404 /index.php;
   
       location ~ \.php$ {
           fastcgi_pass unix:/var/run/php/php8.3-fpm.sock;
           fastcgi_param SCRIPT_FILENAME $realpath_root$fastcgi_script_name;
           include fastcgi_params;
           fastcgi_hide_header X-Powered-By;
       }
   
       location ~ /\.(?!well-known).* {
           deny all;
       }
   
       client_max_body_size 64M;
   }

   After saving the config, enable it and test:

   bash Copy

   ln -s /etc/nginx/sites-available/deprixa /etc/nginx/sites-enabled/
   nginx -t
   systemctl reload nginx

6. 6

   Set Directory Permissions and Storage Symlink

   Laravel needs write access to storage/ and bootstrap/cache/. Set the owner to your web server user (typically www-data on Ubuntu). Then create the public storage symlink.

   bash Copy

   chown -R www-data:www-data /var/www/deprixa-plus
   chmod -R 775 /var/www/deprixa-plus/storage
   chmod -R 775 /var/www/deprixa-plus/bootstrap/cache
   php artisan storage:link

7. 7

   Run the Installation Wizard

   Open your browser and navigate to https://yourdomain.com/install. The wizard will guide you through 5 steps:

   Wizard URL

   Navigate to /install on your domain. For example: https://app.yourdomain.com/install. The wizard is only accessible before the application has been installed. Once installation is complete, this URL is disabled automatically.

   Step 1 — Requirements Check

   URL: /install — Automatically checks that PHP version, required extensions (PDO, OpenSSL, cURL, Zip, Mbstring, GD), and directory permissions are met. All checks must pass (green) before the Next button becomes active.

   

   Step 2 — License Activation

   URL: /install/license — Enter your Envato Purchase Code (UUID format) and your Envato username. Click Verify License. When validation succeeds, the Next button becomes active.

   

   Step 3 — Database & Company Information

   URL: /install/database — Enter your MySQL connection details (host, port, database name, username, password) and your company information (name, email, phone, country, address). Use the Test Connection button to verify before proceeding. The wizard creates the database if it does not exist and imports the application schema automatically.

   

   After clicking "Test Connection":

   

   Step 4 — Administrator Account

   URL: /install/admin — Create the first administrator account. Enter a name, email address, and a strong password (minimum 8 characters). This account will have super-admin access to every feature in the system.

   

   Step 5 — System Preferences

   URL: /install/preferences — Configure the system defaults: language (Spanish or English), timezone (auto-detected from your browser), currency, date format, weight unit (kg/lb), and dimension unit (cm/in). Optionally enable Load demo data to populate the system with sample shipments and customers for testing.

   

   Installation Complete

   After clicking Finish Installation, the system creates the storage symlink, writes the lock file, and redirects you to the login page. Use the admin credentials you created in Step 4 to log in.

   

   Where to Find Your Purchase Code

   Log in to Envato Market (codecanyon.net) → click your avatar → Downloads → find Deprixa Plus → click License certificate & purchase code. The purchase code is a UUID in the format xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.

   When the wizard finishes, you will be redirected to /login. Use the admin credentials you created in Step 4 to log in.

Installation on Hostinger Shared Hosting

Hostinger Business and Premium plans include SSH access and support PHP 8.2/8.3, making them compatible with Deprixa Plus. The key difference from a VPS is that you use the Hostinger File Manager or FTP to upload files and the Hostinger hPanel to create the database — SSH is used only for running Composer and Artisan commands.

1. 1

   Create a MySQL Database in hPanel

   Log in to your Hostinger account → go to hPanel → Databases → MySQL Databases. Click Create a new MySQL database & user. Write down the database name, username, and password — you will need them in the installation wizard.

   The database host on Hostinger is typically 127.0.0.1.

2. 2

   Upload the Files

   In hPanel, go to File Manager and navigate to the public_html folder (or a subdomain directory if you're installing on a subdomain). Upload the deployment ZIP and extract it there.

   After extraction, the file structure should look like:

   text

   public_html/
   ├── app/
   ├── bootstrap/
   ├── config/
   ├── database/
   ├── public/          ← web root should point here
   │   ├── build/       ← compiled frontend (must exist)
   │   └── index.php
   ├── resources/
   ├── routes/
   ├── storage/
   ├── vendor/          ← PHP dependencies (must exist)
   ├── .env.example
   └── artisan

   If you are installing in a subdomain, set the subdomain's document root to point to the public/ folder inside the uploaded directory. Do this in hPanel → Subdomains → Edit → Document Root.

3. 3

   Configure .env via File Manager

   In File Manager, find .env.example, duplicate it and rename the copy to .env. Open .env and set at minimum:

   env Copy

   APP_NAME="Deprixa Plus"
   APP_ENV=production
   APP_DEBUG=false
   APP_URL=https://yourdomain.com
   
   DB_CONNECTION=mysql
   DB_HOST=127.0.0.1
   DB_PORT=3306
   DB_DATABASE=your_database_name
   DB_USERNAME=your_database_user
   DB_PASSWORD=your_database_password

   Leave APP_KEY blank for now — you will generate it via SSH in the next step.

4. 4

   Connect via SSH and Generate App Key

   In hPanel, go to Advanced → SSH Access to get your SSH credentials and enable SSH if not already active. Then connect from your terminal:

   bash — your local terminal Copy

   ssh username@yourdomain.com -p 65002

   Once connected, navigate to the project folder and generate the app key:

   bash — SSH session on Hostinger Copy

   cd ~/public_html            # or ~/domains/yourdomain.com/public_html
   php artisan key:generate
   php artisan storage:link

   If you installed into a subdirectory (e.g., public_html/app/), adjust the path accordingly. The storage:link command creates the symlink so uploaded files (logos, attachments) are publicly accessible.

5. 5

   Set Directory Permissions via SSH

   bash — SSH session on Hostinger Copy

   chmod -R 775 storage bootstrap/cache

6. 6

   Configure the Document Root

   Hostinger must serve the public/ directory, not the root of the project. In hPanel:

   • For the main domain: go to hPanel → Hosting → Manage → Files → Document Root and set it to public_html/public (if you placed the project files directly in public_html).
   • For a subdomain: go to hPanel → Subdomains → Edit → Document Root and point it to the public/ subfolder inside your uploaded directory.

   If your hosting plan does not allow changing the document root, you can move the contents of the public/ folder into public_html/ and update public/index.php paths — but this is not recommended. Using a subdomain with the correct document root is the cleanest approach.

7. 7

   Run the Installation Wizard

   Open your browser and navigate to https://yourdomain.com/install. Follow the 5-step wizard. In Step 3, enter the database credentials you created in Step 1 of this guide.

   Cron Job on Hostinger

   After installation, add a cron job in hPanel → Advanced → Cron Jobs. Set the command to: php ~/public_html/artisan schedule:run and the interval to every minute (use the "Once per minute" preset). This is required for scheduled notifications and auto-status updates to work.

Environment Variables Reference (.env)

All configuration is done through the .env file at the project root. Never commit this file to version control. Database credentials entered in the installation wizard are written to this file automatically.

Application Settings

Database

These values are written automatically by the installation wizard when you complete Step 3. You can also set or update them manually here.

Cache, Session & Queue

Mail Configuration

File Storage (Optional S3)

By default, uploaded files (logos, attachments) are stored on the local server filesystem. To use AWS S3 or a compatible object storage service instead, set the following variables.

First-Run Checklist

After the installation wizard completes, log in with the admin account you created and finish these steps before going live:

• Set your company logo and contact details (Settings → Company Profile)
• Configure your mail settings and send a test email (Settings → Notifications)
• Review your timezone and date format (Settings → Locale)
• Create at least one branch (Settings → Branches)
• Configure shipment service types (Settings → Services)
• Create additional user accounts and assign roles (Settings → Users)
• Set up SSL (Let's Encrypt with Certbot is free and recommended)
• Configure a cron job for scheduled tasks (see below)
• Set up a queue worker for background jobs (Supervisord recommended)
• Test the shipment creation workflow end-to-end

Cron Job for Scheduled Tasks

Add the following entry to your server's crontab (crontab -e as the web server user or root):

* * * * * www-data php /var/www/deprixa-plus/artisan schedule:run >> /dev/null 2>&1

Queue Worker (Supervisord)

For production, use Supervisord to keep the queue worker running. Create /etc/supervisor/conf.d/deprixa-worker.conf:

[program:deprixa-worker]
process_name=%(program_name)s_%(process_num)02d
command=php /var/www/deprixa-plus/artisan queue:work redis --sleep=3 --tries=3 --max-time=3600
autostart=true
autorestart=true
stopasgroup=true
killasgroup=true
user=www-data
numprocs=2
redirect_stderr=true
stdout_logfile=/var/log/deprixa-worker.log
stopwaitsecs=3600

Common Installation Errors