Forem: Rabeea Ali

How to export Million records using Laravel

Rabeea Ali — Sun, 18 Dec 2022 13:30:03 +0000

In this post I diccuses how to export Million(s) records with Laravel using queue job Batching

Before anything make sure to migrate batches table using:

php artisan queue:batches-table
 
php artisan migrate

And put in .env file QUEUE_CONNECTION=database

Now let's get started

Step 1: Controller file

In my controller I have this code:

public function export()
{
    $chunkSize = 10000;
    $usersCount = User::count();
    $numberOfChunks = ceil($usersCount / $chunkSize);

    $folder = now()->toDateString() . '-' . str_replace(':', '-', now()->toTimeString());

    $batches = [
        new CreateUsersExportFile($chunkSize, $folder)
    ];

    if ($usersCount > $chunkSize) {
        $numberOfChunks = $numberOfChunks - 1;
        for ($numberOfChunks; $numberOfChunks > 0; $numberOfChunks--) {
            $batches[] = new AppendMoreUsers($numberOfChunks, $chunkSize, $folder);
        }
    }

    Bus::batch($batches)
        ->name('Export Users')
        ->then(function (Batch $batch) use ($folder) {
            $path = "exports/{$folder}/users.csv";
            // upload file to s3
            $file = storage_path("app/{$folder}/users.csv");
            Storage::disk('s3')->put($path, file_get_contents($file));
            // send email to admin
        })
        ->catch(function (Batch $batch, Throwable $e) {
            // send email to admin or log error
        })
        ->finally(function (Batch $batch) use ($folder) {
            // delete local file
            Storage::disk('local')->deleteDirectory($folder);
        })
        ->dispatch();

    return redirect()->back();
}

Step 2: Creating Job files

We need two main job files, create one called CreateUsersExportFile and the other called AppendMoreUsers

In CreateUsersExportFile:

class CreateUsersExportFile implements ShouldQueue
{
    use Batchable, Dispatchable, InteractsWithQueue, Queueable, SerializesModels;

    public function __construct(
        public $chunkSize,
        public $folder
    ) {
    }

    public function handle()
    {
        $users = User::query()
            ->take($this->chunkSize)
            ->get();

        Storage::disk('local')->makeDirectory($this->folder);

        (new \Rap2hpoutre\FastExcel\FastExcel($this->usersGenerator($users)))
            ->export(storage_path("app/{$this->folder}/users.csv"), function ($user) {
                return [
                    'id' => $user->id,
                    'name' => $user->id,
                    'email' => $user->id,
                    // ....
                ];
            });
    }
}

private function usersGenerator($users)
{
   foreach ($users as $user) {
      yield $user;
   }
}

Note: I'm using FastExcel pkg for export file.

In CreateUsersExportFile:

class AppendMoreUsers implements ShouldQueue
{
    use Batchable, Dispatchable, InteractsWithQueue, Queueable, SerializesModels;

    public function __construct(
        public $chunkIndex,
        public $chunkSize,
        public $folder
    ) {
    }

    public function handle()
    {
        $users = User::query()
            ->skip($this->chunkIndex * $this->chunkSize)
            ->take($this->chunkSize)
            ->get()
            ->map(function ($user) {
                return [
                    $user->id,
                    $user->name,
                    $user->email,
                ];
            });

        $file = storage_path("app/{$this->folder}/users.csv");
        $open = fopen($file, 'a+');
        foreach ($users as $user) {
            fputcsv($open, $user);
        }
        fclose($open);
    }
}

Now run php artisan queue:work and send your request.

Install SSL On Server With Soketi

Rabeea Ali — Sun, 04 Sep 2022 12:44:18 +0000

PART 1
PART 2
PART 3

In this part we will see how to configure Soketi and how to install SSL certificate.

Step 1: Change the default config of Soketi

This step is optional

As we know the default credentials of Soketi is:

App ID: app-id
App Key: app-key
Secret: app-secret

To change these credentials first we need to create a folder.

sudo mkdir /etc/my_soketi

Enter the folder (change the folder/file name as you want)

cd /etc/my_soketi

Create a json file config.json

sudo vim config.json

Contains:

{
  "debug": true,
  "port": 6001,
  "appManager.array.apps": [
    {
      "id": "your-new-id",
      "key": "your-new-key",
      "secret": "your-new-secret"
    }
  ]
}

If you want to see the logs of Soketi make "debug": true,, and if you do not care just make false.

Now we need to turn off our Soketi server running by pm2:

pm2 stop soketi

If you need to know the name run pm2 status and take the name of service

And now rerun the Soketi server by:

pm2 start soketi -- start --config=/etc/my_soketi/config.json

Now change the credentials in Laravel project in .env file to the new one.

Step 2: Link IP With Domain

Go to the domain provider and make a new subdomain(domain) and create a new record then put your public IP.

After you make sure that the subdomain is run your Soketi server by returning OK when you open the domain, go to Nginx config file and update the server_name to your subdomain.

sudo vim /etc/nginx/nginx.conf

server_name  your_subodmain;

Now restart the Nginx

sudo systemctl restart nginx.service

Step 3: Install SSL

I will use let's encrypt to install SSL on my domain.

To install SSL run these three commands:

sudo yum install -y https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm

sudo yum-config-manager --enable epel

sudo yum install certbot python2-certbot-nginx -y

Then run:

sudo certbot --nginx

Some questions will show:

1. type your email: XXXXXX@gmail.com
2. (Y)es/(N)o: y
3. (Y)es/(N)o: y
4.  blank to select all options shown (Enter 'c' to cancel): 1

Now you will get your SSL on domain once you visit it.

To renew the Certificate automatically you need to set a cronjob via crontab. The commands are given below.

sudo crontab -e

put this line into the file:

0 3 * * * sudo certbot renew >/dev/null 2>&1

Step 4: Configure The Laravel App With SSL.

in .env:

PUSHER_APP_KEY=key
PUSHER_APP_ID=id
PUSHER_APP_SECRET=secret
PUSHER_HOST="sub.app.co"
PUSHER_PORT=443
PUSHER_SCHEME=https

VITE_PUSHER_APP_KEY="${PUSHER_APP_KEY}"
VITE_PUSHER_HOST="${PUSHER_HOST}"
VITE_PUSHER_PORT="${PUSHER_PORT}"
VITE_PUSHER_SCHEME="${PUSHER_SCHEME}"

In bootstrap.js:

window.Echo = new Echo({
    broadcaster: "pusher",
    key: import.meta.env.VITE_PUSHER_APP_KEY,
    forceTLS: false,
    encrypted: import.meta.env.VITE_PUSHER_ENCRYPTED === "true",
    wsHost: import.meta.env.VITE_PUSHER_HOST,
    wsPort: import.meta.env.VITE_PUSHER_PORT,
    wssPort: import.meta.env.VITE_PUSHER_PORT,
    disableStats: true,
    enabledTransports: ["ws", "wss"],
});

That's it 🚀

I would thank @Sinnbeck on laracast.com that helping me to finish this series ❤️

Deploy Soketi On Server

Rabeea Ali — Fri, 26 Aug 2022 14:48:38 +0000

PART 1
PART 2
PART 3

In this post we will see how to deploy Soketi On AWS EC2. You can install it on whatever Hosting you have.

Prerequisites:

• Ready Fresh EC2 Instance

I used EC2 t2.micro

Now Connect With SSH And Let's Get Started 🚀

Step 1: prepare OS & Install The Tools

Update the server pkgs:

sudo yum update -y

Install the required tools:

sudo yum install -y git python3 gcc build-essential

Step 2: Install Nodejs

Let's install node js & npm packages with these three commands

Please run one by one

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.34.0/install.sh | bash

. ~/.nvm/nvm.sh

nvm install --lts

To Check the version of node run:

node -e "console.log('Running Node.js ' + process.version)"

You should see Running Node.js: 1xxxx

Step 3: Install Soketi

Now let's install Soketi on the server with:

npm install -g @soketi/soketi

Step 4: Keep The Soketi Server Alive

There are two ways to make Soketi alive by using Supervisor or PM2

For more information check the docs

I will choose PM2 & let's install it:

npm install -g pm2

Now run Soketi using pm2:

pm2 start soketi -- start

More commands might be useful for debugging Soketi:

pm2 status
pm2 monit
pm2 logs

Step 5: Nginx

As we know Soketi using port 6001 by default and we need a way to make the server redirect to this port for anyone visiting the main domain, for that we need a web server that runs on port 80 and redirect to users to 6001, so Nginx(proxy) is prefect for this job.

Let's install Nginx:

sudo amazon-linux-extras install nginx1

Then start the Nginx:

sudo systemctl start nginx.service

Check the status of Nginx:

sudo systemctl status nginx.service

Now we need to Find the Nginx config file, you use command like nginx -t to give you the full path config file, or you probably find it in /etc/nginx/nginx.conf.

Let's open the config file with:

sudo vim /etc/nginx/nginx.conf

Now add the proxy in nginx.conf inside server block:

server { 
   .......

    location / {
        proxy_pass             http://127.0.0.1:6001;
        proxy_read_timeout     60;
        proxy_connect_timeout  60;
        proxy_redirect         off;

        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection 'upgrade';
        proxy_set_header Host $host;
        proxy_cache_bypass $http_upgrade;
    }
 }

Save & Exit :wq :)

After adding the proxy, we need to restart the Nginx:

sudo systemctl restart nginx.service

Now if you visit your public IP, you will see OK in the page, and that's mean you successfully redirect the server to Soketi port which is 6001. 🫡

After all, you now can use your public IP (without http://) in Laravel project by edit the .env with:

PUSHER_HOST=YOUR_PUBLIC_IP_HERE
PUSHER_PORT=80

THAT'S FOR THIS PART

In part 3 we will see how to install SSL and change the configurations of Soketi.

👋

How to use Soketi with Laravel

Rabeea Ali — Wed, 24 Aug 2022 13:49:35 +0000

PART 1
PART 2
PART 3

On today's post we will see how to use Soketi as a WebSockets server with Laravel. this post will be using all things locally and in the Pt.2 we will deploy Soketi on EC2.

Prerequisites:

• A Laravel 9 project.
• Node js
• Python 3.x
• GIT
• The gcc compiler and the dependencies for build

Make sure to have all above tools installed on your machine before move on.

NOTE: there are several ways to install Soketi check the official docs

NOTE2: if you are using Mac OS like in my case use brew to install all three above packages:

brew install gcc
...

Step 1: Install & Running Soketi

Now install Soketi globally on your machine by running:

npm install -g @soketi/soketi

After the installation is finished run:

soketi start

You should getting something like this:

Step 2: Install Laravel Related Packages(client, server)

To use pusher driver with Laravel you should install the Pusher Channels PHP SDK using the Composer package manager:

composer require pusher/pusher-php-server

To receive the event to client side you should install these two packages throw NPM:

npm install --save-dev laravel-echo pusher-js

Last thing install laravel/breeze:

composer require laravel/breeze

php artisan breeze:install

Step 3: Configure Soketi with Laravel

First open config/broadcasting.php file and change the pusher driver to the following:

'connections' => [

    // ...

    'pusher' => [
        'driver' => 'pusher',
        'key' => env('PUSHER_APP_KEY', 'app-key'),
        'secret' => env('PUSHER_APP_SECRET', 'app-secret'),
        'app_id' => env('PUSHER_APP_ID', 'app-id'),
        'options' => [
            'host' => env('PUSHER_HOST', '127.0.0.1'),
            'port' => env('PUSHER_PORT', 6001),
            'scheme' => env('PUSHER_SCHEME', 'http'),
            'encrypted' => true,
            'useTLS' => env('PUSHER_SCHEME') === 'https',
        ],
    ],
],

We need to update our .env file with the new configuration details:

PUSHER_APP_KEY=app-key
PUSHER_APP_ID=app-id
PUSHER_APP_SECRET=app-secret
PUSHER_HOST=127.0.0.1
PUSHER_PORT=6001

VITE_PUSHER_APP_KEY="${PUSHER_APP_KEY}"
VITE_PUSHER_HOST="${PUSHER_HOST}"
VITE_PUSHER_PORT="${PUSHER_PORT}"
VITE_PUSHER_SCHEME="${PUSHER_SCHEME}"

Also in the .env change BROADCAST_DRIVER to pusher

Now go to resources/js/bootstrap.js file and uncomment the last lines:

import Echo from "laravel-echo";

import Pusher from "pusher-js";
window.Pusher = Pusher;

window.Echo = new Echo({
    broadcaster: "pusher",
    key: import.meta.env.VITE_PUSHER_APP_KEY,
    wsHost:
        import.meta.env.VITE_PUSHER_HOST ??
        `ws-${import.meta.env.VITE_PUSHER_APP_CLUSTER}.pusher.com`,
    wsPort: import.meta.env.VITE_PUSHER_PORT ?? 80,
    wssPort: import.meta.env.VITE_PUSHER_PORT ?? 443,
    forceTLS: (import.meta.env.VITE_PUSHER_SCHEME ?? "https") === "https",
    enabledTransports: ["ws", "wss"],
});

Step 4: Use Soketi with Laravel

Create a new event php artisan make:event OrderStatusUpdated

Open it and change make it like this:

class OrderStatusUpdated implements ShouldBroadcast
{
    use Dispatchable, InteractsWithSockets, SerializesModels;

    public function __construct()
    {
    }

    public function broadcastOn()
    {
        return new Channel('orders');
    }
}

Then in resources/js/bootstrap.js at the end add this code:

window.Echo.channel("orders").listen("OrderStatusUpdated", (e) => {
    console.log(e);
});

It's simple event listener to listen OrderStatusUpdated once it's fire.

Now go to web.php and create a new route for running the event

Route::get('/fire', function () {
    OrderStatusUpdated::dispatch();

    return 'Event has been sent!';
});

Step 5: Testing

Open two tabs in your browser:

First soketi.test/dashboard and open the console to just see the event.

Second Run the event by visiting soketi.test/fire

Once you hit the second URL you should see the event in the first tab in REAL-TIME WAY :)

========== The End =============

Another useful resources:

1- Laracast course that explains in details about the Broadcasting events in Laravel.

2- Always check the official docs of Soketi for more details.

See you in PT.2 :)

How to use Bitly to shorten URL with Laravel

Rabeea Ali — Sat, 22 Jan 2022 19:33:09 +0000

Today's post we will see how to use Bitly to shorten URL with Laravel without any external package in easy way.

Prerequisites:

• A Laravel project.
• An Account on Bitly.

Step 1: Get token from Bitly

After login in Bitly go to this page and enter your password then click Generate token

Step 2: Create Service for Bitly

Now go to your Laravel project and in app directory create a folder called Services and inside it create a file called Bitly.php will contains this:

<?php

namespace App\Services;

use Throwable;
use Illuminate\Support\Facades\Http;

class Bitly
{
    public static function convert($link)
    {
        try {
            $response =  Http::accept('application/json')
                ->withToken('6ec991aXXXXXXXXXX40c996d88afa')
                ->post('https://api-ssl.bitly.com/v4/shorten', 
                    "domain" => "bit.ly",
                    "long_url" => $link,
                ]);

            $body = $response->json();

            return $body['link'];
        } catch (Throwable $e) {
            return 'invalid url';
        }
    }
}

In withToken put your token that you get from Bitly

In this class I used Http which is guzzlehttp/guzzle package that comes with Laravel by default.
$body have several information you can use it, just dd($body) and see if they help you.
I used try|catch for the purpose of anyone entering an invalid URL.

For sure you can create config file for the token and put it in .env file.

Step 3: Use Bitly service

Now go to your controller and use Bitly class, something like this:

use App\Services\Bitly;

class BitlyController extends Controller
{
    public function __invoke()
    {
        $link = Bitly::convert('https://dev.to');

        return $link;
    }
}

The $link will return the Bitly short url use it as you want.

How to reset the password via a code using Laravel API

Rabeea Ali — Wed, 19 Jan 2022 12:10:06 +0000

Every Laravel project has a built-in the password reset process. It works perfectly with the web, but when it comes to mobile apps, this method will cause problems because it requires users to go to a web page to reset their password! I think this is not the best way to do such a thing, so the code password reset is pretty useful when you have mobile apps.

You will find the full code with better code written at the end of the post.

Prerequisites:

• A Laravel project
• An Account in Mailtrap & get credentials and put it in the .env file.

Step 1: Create a new reset code table

Each Laravel project comes with a password_resets table, I will leave this table(If your Laravel app just API for mobile apps then use password_resets) for web users and create another table for mobile app users as follows:

1- run this command in the terminal

 php artisan make:model ResetCodePassword -m

2- open the reset_code_passwords_table migration and it will be something like this:

Schema::create('reset_code_passwords', function (Blueprint $table) {
    $table->string('email')->index();
    $table->string('code');
    $table->timestamp('created_at')->nullable();
});

Now migrate the table with php artisan migrate.

3- open ResetCodePassword then fill the $fillable with columns names:

protected $fillable = [
    'email',
    'code',
    'created_at',
];

Note: feel free to change anything you need

Step 2: Create files

Create a new directory in controllers called Api then create these three controllers:

ForgotPasswordController.php   // step 1
CodeCheckController.php        // step 2
ResetPasswordController.php    // step 3

Create a mail class for email:

php artisan make:mail SendCodeResetPassword

Now let's fill these files, The first one ForgotPasswordController.php will be something like this:

class ForgotPasswordController extends Controller
{
    public function __invoke(Request $request)
    {
        $data = $request->validate([
            'email' => 'required|email|exists:users',
        ]);

        // Delete all old code that the user sent before.
        ResetCodePassword::where('email', $request->email)->delete();

        // Generate random code
        $data['code'] = mt_rand(100000, 999999);

        // Create a new code
        $codeData = ResetCodePassword::create($data);

        // Send email to user
        Mail::to($request->email)->send(new SendCodeResetPassword($codeData->code));

        return response(['message' => trans('passwords.sent')], 200);
    }
}

in CodeCheckController.php:

class CodeCheckController extends Controller
{
    public function __invoke(Request $request)
    {
        $request->validate([
            'code' => 'required|string|exists:reset_code_passwords',
        ]);

        // find the code
        $passwordReset = ResetCodePassword::firstWhere('code', $request->code);

        //Check if it has not expired: the time is one hour
        if ($passwordReset->created_at > now()->addHour()) {
            $passwordReset->delete();
            return response(['message' => trans('passwords.code_is_expire')], 422);
        }

        return response([
            'code' => $passwordReset->code,
            'message' => trans('passwords.code_is_valid')
        ], 200);
    }
}

in CodeCheckController.php:

class CodeCheckController extends Controller
{
    public function __invoke(Request $request)
    {
        $request->validate([
            'code' => 'required|string|exists:reset_code_passwords',
            'password' => 'required|string|min:6|confirmed',
        ]);

        // find the code
        $passwordReset = ResetCodePassword::firstWhere('code', $request->code);

        //Check if it has not expired: the time is one hour
        if ($passwordReset->created_at > now()->addHour()) {
            $passwordReset->delete();
            return response(['message' => trans('passwords.code_is_expire')], 422);
        }

        // find user's email 
        $user = User::firstWhere('email', $passwordReset->email);

        // update user password
        $user->update($request->only('password'));

        // delete current code 
        $passwordReset->delete();

        return response(['message' =>'password has been successfully reset'], 200);
    }
}

Step 3: Handel Mail and blade file

In SendCodeResetPassword.php mail:

class SendCodeResetPassword extends Mailable implements ShouldQueue
{
    use Queueable, SerializesModels;

    public $code;

    public function __construct($code)
    {
        $this->code = $code;
    }

    public function build()
    {
        return $this->markdown('emails.send-code-reset-password');
    }
}

In send-code-reset-password.blade.php

@component('mail::message')
<h1>We have received your request to reset your account password</h1>
<p>You can use the following code to recover your account:</p>

@component('mail::panel')
{{ $code }}
@endcomponent

<p>The allowed duration of the code is one hour from the time the message was sent</p>
@endcomponent

Step 4: Create routes

In routes/api.php create links for your controllers:

Route::post('password/email',  ForgotPasswordController::class);
Route::post('password/code/check', CodeCheckController::class);
Route::post('password/reset', ResetPasswordController::class);

Now you can open Postman and try these links:

http://your-domain.com/api/password/email       => Step 1
http://your-domain.com/api/password/code/check  => Step 2
http://your-domain.com/api/password/reset       => Step 3

Source code on Github

Send push notifications from Laravel to IOS & Android

Rabeea Ali — Tue, 18 Jan 2022 21:28:05 +0000

In this article, we will see how to send push notifications from a Laravel app to iOS and Android apps using FCM (Firebase Cloud Messaging).

Prerequisites:

• A Laravel project
• Firebase account
• Create a new app in Firebase

Step 1: Get `fcm_token` from Firebase

Click on the app settings icon, then choose project settings

Then, from the tabs, go to Cloud Messaging and you will get the token there. Copy it.

Step 2: Create the Config file

Now, in your Laravel project, go tothe Config directory & create a new file called fcm.php containing:

<?php

// config/fcm.php

return [
    'token' => "AAAA6ll7Hs4:XXXXXXXXXXXXXXX",
];

As you see above, you should put the token that you get from FCM dashboard in fcm_token.

Step 3: Add a column in the `users` table

Now go to users migration & add a new column fcm_token:

Schema::create('users', function (Blueprint $table) {
    $table->id();
    .....
    $table->string('fcm_token')->nullable();
    $table->timestamps();
});

What is the benefit of this column?

Each device should have one token, so the ISO & Android developers should install Firebase SDK on the ap,p and each time a new user joins your app, they should generate a token for the user device then send it to your API as a Backend to save this token in the user's table.

I prefer the way when any user register in your apps, the mobile developer send me a token of this user and I store it with the user's information.

Step 4: Make `services` folder

In the app directory, create a new folder Services and inside it create a file FCMService.php containing:

<?php

namespace App\Services;

use Illuminate\Support\Facades\Http;

class FCMService
{ 
    public static function send($token, $notification)
    {
        Http::acceptJson()->withToken(config('fcm.token'))->post(
            'https://fcm.googleapis.com/fcm/send',
            [
                'to' => $token,
                'notification' => $notification,
            ]
        );
    }
}

Step 5: Send notifications to apps

Now in your controller, you can use FCMService class to send notifications to apps, in my case, I have UserController, the code is going to be as follows:

<?php

namespace App\Http\Controllers;

use App\Models\User;
use App\Services\FCMService;
use App\Http\Controllers\Controller;

class UserController extends Controller 
{
    public function sendNotificationrToUser($id)
    {
       // get a user to get the fcm_token that already sent.               from mobile apps 
       $user = User::findOrFail($id);

      FCMService::send(
          $user->fcm_token,
          [
              'title' => 'your title',
              'body' => 'your body',
          ]
      );

    }
}

Extra stuff

1 - If you want to send an image with the notification, you can easily do it by storing the image in a place( your server or something like S3 from AWS), then get the full path of the image and add to the second array of the notification as follows:

 // store the image & get the URL `$image_url`
 FCMService::send(
    $user->fcm_token,
    [
        'title' => 'your title',
        'body' => 'your body',
        'image' => $image_url
    ],
);

2- If you want to send a notification to all users that you have from your admin panel or somewhere, you need to use a queue job, especially if you have a large number of users in your database.

3- If you want to use another way, check this PKG out
https://laravel-notification-channels.com/fcm/#contents

Install supervisor on AWS EB with Laravel

Rabeea Ali — Sat, 05 Jun 2021 20:24:14 +0000

In this article, we will see how to install Supervisor on AWS Elastic Beanstalk with Laravel.

Prerequisites:

• I assume you deployed your Laravel project on AWS Elastic Beanstalk & make all configurations of queue & etc.
• Connect to SSH.
• I'm using Amazon Linux 2 (Nginx server).
• PHP 7.4 installed on AWS.

After connect to ssh follow these steps:

Step 1: Install EPEL

The EPEL repository is an additional package repository that provides easy access to install packages for commonly used software.

$ sudo amazon-linux-extras install epel

Step 2: Install supervisor

Let's install supervisor run the following command.

$ sudo yum install -y supervisor

Step 3: Edit configuration file

Go to the default configuration file.

$ sudo vim /etc/supervisord.conf

Change the include directory at the end to:

files = supervisord.d/*.conf

Step 4: Create new files

Add a new configuration file. If the directory doesn’t exist, then make one.

$ sudo vim /etc/supervisord.d/NameYouLike.conf

Give the setting:

[program:laravel-worker]
process_name=%(program_name)s_%(process_num)02d
command=php /var/app/current/artisan queue:work sqs --sleep=3 --tries=3 --max-time=3600
autostart=true
autorestart=true
stopasgroup=true
killasgroup=true
user=root
numprocs=8
redirect_stderr=true
stdout_logfile=/var/app/current/storage/worker.log
stopwaitsecs=3600

Note ⭕️

In command line, I'm using SQS for the queue, if you are using (Database or Redis) you should change it to the thing that you are using.

Step 5: Launch Supervisor

$ sudo supervisord -c /etc/supervisord.conf

Step 6: Apply The Changes

Apply new setting and check the status

$ sudo supervisorctl update;
$ sudo supervisorctl status

You should see something like that:

Step 7: Automatic start after system reboot

Add a new configuration of restart Supervisor

$ sudo vim /etc/init.d/supervisord

Give this settings inside the file:

#! /bin/sh
### BEGIN INIT INFO
# Provides:          supervisord
# Required-Start:    $remote_fs
# Required-Stop:     $remote_fs
# Default-Start:     2 3 4 5
# Default-Stop:      0 1 6
# Short-Description: Example initscript
# Description:       This file should be used to construct scripts to be
#                    placed in /etc/init.d.
### END INIT INFO

# Author: Dan MacKinlay <danielm@phm.gov.au>
# Based on instructions by Bertrand Mathieu
# http://zebert.blogspot.com/2009/05/installing-django-solr-varnish-and.html

# Do NOT "set -e"

# PATH should only include /usr/* if it runs after the mountnfs.sh script
PATH=/sbin:/usr/sbin:/bin:/usr/bin
DESC="Description of the service"
NAME=supervisord
DAEMON=/usr/local/bin/supervisord
DAEMON_ARGS=""
PIDFILE=/var/run/$NAME.pid
SCRIPTNAME=/etc/init.d/$NAME

# Exit if the package is not installed
[ -x "$DAEMON" ] || exit 0

# Read configuration variable file if it is present
[ -r /etc/default/$NAME ] && . /etc/default/$NAME

# Load the VERBOSE setting and other rcS variables
. /lib/init/vars.sh

# Define LSB log_* functions.
# Depend on lsb-base (>= 3.0-6) to ensure that this file is present.
. /lib/lsb/init-functions

#
# Function that starts the daemon/service
#
do_start()
{
    # Return
    #   0 if daemon has been started
    #   1 if daemon was already running
    #   2 if daemon could not be started
    start-stop-daemon --start --quiet --pidfile $PIDFILE --exec $DAEMON --test > /dev/null \
        || return 1
    start-stop-daemon --start --quiet --pidfile $PIDFILE --exec $DAEMON -- \
        $DAEMON_ARGS \
        || return 2
    # Add code here, if necessary, that waits for the process to be ready
    # to handle requests from services started subsequently which depend
    # on this one.  As a last resort, sleep for some time.
}

#
# Function that stops the daemon/service
#
do_stop()
{
    # Return
    #   0 if daemon has been stopped
    #   1 if daemon was already stopped
    #   2 if daemon could not be stopped
    #   other if a failure occurred
    start-stop-daemon --stop --quiet --retry=TERM/30/KILL/5 --pidfile $PIDFILE --name $NAME
    RETVAL="$?"
    [ "$RETVAL" = 2 ] && return 2
    # Wait for children to finish too if this is a daemon that forks
    # and if the daemon is only ever run from this initscript.
    # If the above conditions are not satisfied then add some other code
    # that waits for the process to drop all resources that could be
    # needed by services started subsequently.  A last resort is to
    # sleep for some time.
    start-stop-daemon --stop --quiet --oknodo --retry=0/30/KILL/5 --exec $DAEMON
    [ "$?" = 2 ] && return 2
    # Many daemons don't delete their pidfiles when they exit.
    rm -f $PIDFILE
    return "$RETVAL"
}

#
# Function that sends a SIGHUP to the daemon/service
#
do_reload() {
    #
    # If the daemon can reload its configuration without
    # restarting (for example, when it is sent a SIGHUP),
    # then implement that here.
    #
    start-stop-daemon --stop --signal 1 --quiet --pidfile $PIDFILE --name $NAME
    return 0
}

case "$1" in
  start)
    [ "$VERBOSE" != no ] && log_daemon_msg "Starting $DESC" "$NAME"
    do_start
    case "$?" in
        0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
        2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
    esac
    ;;
  stop)
    [ "$VERBOSE" != no ] && log_daemon_msg "Stopping $DESC" "$NAME"
    do_stop
    case "$?" in
        0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
        2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
    esac
    ;;
  #reload|force-reload)
    #
    # If do_reload() is not implemented then leave this commented out
    # and leave 'force-reload' as an alias for 'restart'.
    #
    #log_daemon_msg "Reloading $DESC" "$NAME"
    #do_reload
    #log_end_msg $?
    #;;
  restart|force-reload)
    #
    # If the "reload" option is implemented then remove the
    # 'force-reload' alias
    #
    log_daemon_msg "Restarting $DESC" "$NAME"
    do_stop
    case "$?" in
      0|1)
        do_start
        case "$?" in
            0) log_end_msg 0 ;;
            1) log_end_msg 1 ;; # Old process is still running
            *) log_end_msg 1 ;; # Failed to start
        esac
        ;;
      *)
        # Failed to stop
        log_end_msg 1
        ;;
    esac
    ;;
  *)
    #echo "Usage: $SCRIPTNAME {start|stop|restart|reload|force-reload}" >&2
    echo "Usage: $SCRIPTNAME {start|stop|restart|force-reload}" >&2
    exit 3
    ;;
esac

:

Add execute authority

$ sudo chmod +x /etc/init.d/supervisord

Add the configuration into system

$ sudo chkconfig --add supervisord

Switch on the configuration and start

$ sudo service supervisord start

That it 🥳🚀

How to deploy Inertia.js on Heroku 🚀

Rabeea Ali — Thu, 01 Apr 2021 12:05:25 +0000

In this article, we will see how to deploy an Inertia.js application to Heroku; a container-based cloud Platform as a Service (PaaS), which developers use to deploy, manage and scale modern apps.

Prerequisites:

• PHP and Laravel Knowledge.
• Heroku User Account.
• Download Heroku CLI that appropriate with your system (here).
• Get installed Git on your computer (get git here).

Here I assume your application is ready to deploy.

Let's get started:

Step 1: Add your Procfile & configuration server file.

Add these files to the current working project directory:

Procfile contains:

web: vendor/bin/heroku-php-nginx -C nginx_app.conf /public

nginx_app.conf contains:

location / {
    # try to serve file directly, fallback to rewrite
    try_files $uri @rewriteapp;
}

location @rewriteapp {
    # rewrite all to index.php
    rewrite ^(.*)$ /index.php/$1 last;
}

location ~ ^/index\.php(/|$) {
    try_files @heroku-fcgi @heroku-fcgi;
    # ensure that /index.php isn't accessible directly, but only through a rewrite
    internal;
}

Procfile: Heroku knows which processes to run for your app based on a configuration file called a Procfile. The default apache2 process but we change it to Nginx so we have to set Nginx configuration.
nginx_app.conf: basically means that there are custom configuration settings.

Step 2: Initialize the git repo

Well, our code is ready. Let's get it into git.

$ git init
$ git add .
$ git commit -m "Initial commit of stock Laravel install."

Step 3: Create the Heroku app

Since you have Heroku CLI installed, you can create apps directly from the command line.

$ heroku create

When this is done a random name will be automatically chosen for your application. To change this name use:

$ heroku apps:rename youtNewName

Step 4: Setup a Laravel encryption key

To set up your Laravel encryption key copy the APP_KEY environment value from your .env file and run

$ heroku config:set APP_KEY=YourAppKey

Step 5: Set up & Enabling Node.js

You need to enable node.js in order to run commands node npm commands in production. To do that you need to add heroku/nodejs build pack using:

$ heroku buildpacks:add heroku/nodejs

The node dependencies in your package.json file will be installed on deployment but it won’t install any of your devDependencies. To solve this you need to set an environment variable to tell Heroku to install all dependencies including devDependencies using:

$ heroku config:set NPM_CONFIG_PRODUCTION=false

Then add postinstall in package.json scripts

"scripts": {
  ....
  "postinstall": "npm run prod"
}

Step 6: Deploy your code to the Heroku app

With Heroku, you push new code to your site by pushing to the heroku git remote.

$ git push heroku master

Step 7: Ensure that two Heroku buildpacks

To do this run:

$ heroku buildpacks 
// you have to see:
1. heroku/php
2. heroku/nodejs

Step 8: Set up PostgreSQL database

Heroku provides you with use PostgresSQL for free(limited). To install it run the command:

$ heroku addons:create heroku-postgresql:hobby-dev

Once the installation is done, you have to find the database credentials, open your Heroku account then:

Choose Our App > Resources > click on Heroku Postgres > Settings > click on View Credentials

Now you need to set the environment variables of the database, you can add them directly from the terminal:

$ heroku config:set DB_CONNECTION=XXXXXXX

Finally, you have to migrate your tables, run:

$ heroku run php artisan migrate

That's it 🎉🥳

Now open your app via:

$ heroku open

========================================================

Additional notes:

1- You might face an issue that your assets files do not work! since the domain of the Heroku is "HTTPS" you have to put this code in AppServiceProvider.php in boot method:

 if(config('app.env') === 'production') {
    \URL::forceScheme('https');
 }

2- You might forget to link storage files:

$ heroku run php artisan storage:link

Forem: Rabeea Ali

How to export Million records using Laravel

Step 1: Controller file

Step 2: Creating Job files

Install SSL On Server With Soketi

Step 1: Change the default config of Soketi

Step 2: Link IP With Domain

Step 3: Install SSL

Step 4: Configure The Laravel App With SSL.

Deploy Soketi On Server

Prerequisites:

Step 1: prepare OS & Install The Tools

Step 2: Install Nodejs

Step 3: Install Soketi

Step 4: Keep The Soketi Server Alive

Step 5: Nginx

How to use Soketi with Laravel

Prerequisites:

Step 1: Install & Running Soketi

Step 2: Install Laravel Related Packages(client, server)

Step 3: Configure Soketi with Laravel

Step 4: Use Soketi with Laravel

Step 5: Testing

Another useful resources:

How to use Bitly to shorten URL with Laravel

Prerequisites:

Step 1: Get token from Bitly

Step 2: Create Service for Bitly

Step 3: Use Bitly service

How to reset the password via a code using Laravel API

Prerequisites:

Step 1: Create a new reset code table

Step 2: Create files

Step 3: Handel Mail and blade file

Step 4: Create routes

Send push notifications from Laravel to IOS & Android

Prerequisites:

Step 1: Get fcm_token from Firebase

Step 2: Create the Config file

Step 3: Add a column in the users table

What is the benefit of this column?

Step 4: Make services folder

Step 5: Send notifications to apps

Extra stuff

Install supervisor on AWS EB with Laravel

Prerequisites:

Step 1: Install EPEL

Step 2: Install supervisor

Step 3: Edit configuration file

Step 4: Create new files

Note ⭕️

Step 5: Launch Supervisor

Step 6: Apply The Changes

Step 7: Automatic start after system reboot

That it 🥳🚀

How to deploy Inertia.js on Heroku 🚀

Prerequisites:

Step 1: Add your Procfile & configuration server file.

Step 2: Initialize the git repo

Step 3: Create the Heroku app

Step 4: Setup a Laravel encryption key

Step 5: Set up & Enabling Node.js

Step 6: Deploy your code to the Heroku app

Step 7: Ensure that two Heroku buildpacks

Step 8: Set up PostgreSQL database

That's it 🎉🥳

Additional notes:

Step 1: Get `fcm_token` from Firebase

Step 3: Add a column in the `users` table

Step 4: Make `services` folder