jiannius/atom-livewire

Boilerplate for Larave-Livewire

0.51.1 2024-11-20 14:45 UTC

Requires

• backpack/basset: ^1
• barryvdh/laravel-debugbar: ^3
• barryvdh/laravel-dompdf: ^2.0
• calebporzio/sushi: ^2
• consoletvs/profanity: ^3.3
• doctrine/dbal: ^3.6
• intervention/image: ^3
• jenssegers/agent: ^2.0
• laravel/pail: ^1.0
• laravel/reverb: ^1
• laravel/sanctum: ^3.2
• laravel/socialite: ^5.0
• league/flysystem-aws-s3-v3: ^3.0
• livewire/livewire: ^2.0
• phpoffice/phpword: ^1.1
• rap2hpoutre/fast-excel: ^5.0
• sentry/sentry-laravel: ^3
• stripe/stripe-php: ^10.0
• symfony/http-client: ^6.0
• symfony/mailgun-mailer: ^6.0
• torann/geoip: ^3.0

Requires (Dev)

• orchestra/testbench: ^8.0

MIT

• TJ

README

Static Site Installation

1. Install Laravel

composer create-project laravel/laravel <project-name>
cd <project-name>
npm install

// You don't need this if using Laravel Forge or Laravel Valet
sudo chown www-data:www-data storage -R
sudo chmod 777 storage -R
sudo chmod 777 bootstrap -R

1. Install Atom

composer require jiannius/atom-livewire
php artisan atom:install --static --force
npm install

1. Enable static site in config/atom.php

'static_site' => true,

1. Add middleware to app\Http\Kernel.php

protected $middleware = [
    ...
    \Jiannius\Atom\Http\Middleware\Bootstrap::class, // for site security like https redirect etc
];

1. Start development

npm run dev

Application Installation

1. Create Database

   First you must create a database for your project in MySQL

2. Install Laravel

composer create-project laravel/laravel <project-name>
cd <project-name>
npm install

// You don't need this if using Laravel Forge or Laravel Valet
sudo chown www-data:www-data storage -R
sudo chmod 777 storage -R
sudo chmod 777 bootstrap -R

1. Update .env with database name

DB_DATABASE=<project-name>
DB_USERNAME=root
DB_PASSWORD=password

1. Install Atom

composer require jiannius/atom-livewire

1. Initialize Atom

php artisan atom:init

1. Run migration

php artisan queue:table        // publish queue table from laravel
php artisan migrate
php artisan atom:migrate base  // migrate atom base tables

1. Publish routes. This will copy the base routes from atom to routes/web.php

php artisan atom:publish base

1. Run npm install

npm install

1. Add middleware to app\Http\Kernel.php

protected $middleware = [
    ...
    \Jiannius\Atom\Http\Middleware\Bootstrap::class,
];

1. Configure Sentry for error monitoriing (Optional)

php artisan sentry:publish --dsn=<sentry dsn - get from sentry when create project>

// if develop locally, remember to set sentry dsn to null in .env file
// this is to avoid sending error to sentry server in local environment
SENTRY_LARAVEL_DSN=null
SENTRY_TRACES_SAMPLE_RATE=0

1. Start development

npm run dev

Install Atom Modules

1. Run the migration for the specific module

php artisan atom:migrate                // select the module from the list
php artisan atom:migrate app.label      // optionally, if you know the module name

1. (Optional) Publish the codes to local for further modification

php artisan atom:publish app.label

Modify Livewire\App\Settings

1. To modify the app settings, extend Jiannius\Atom\Http\Livewire\App\Settings\Index.php, and then change the getTabsProperty() method.

// app/Http/Livewire/App/Settings/Index.php

<?php

namespace App\Http\Livewire\App\Settings;

class Index extends \Jiannius\Atom\Http\Livewire\App\Settings\Index
{
    public function getTabsProperty(): array
    {

        return [
            ['group' => 'Account', 'tabs' => [
                ['slug' => 'login', 'label' => 'Login Information', 'icon' => 'login',],
                ['slug' => 'password', 'label' => 'Change Password', 'icon' => 'lock',],
                ['slug' => 'billing', 'label' => 'Subscription', 'icon' => 'credit-card'],
            ]],

            ['group' => 'System', 'tabs' => [
                ['slug' => 'user', 'label' => 'Users', 'icon' => 'users'],
                ['slug' => 'invitation','label' => 'Invitations', 'icon' => 'invitation'],
                ['slug' => 'role', 'label' => 'Roles', 'icon' => 'user-tag'],
                ['slug' => 'team', 'label' => 'Teams', 'icon' => 'people-group'],
                ['slug' => 'page', 'label' => 'Pages', 'icon' => 'newspaper'],
                ['slug' => 'file', 'label' => 'Files and Media', 'icon' => 'images'],
            ]],

            ['group' => 'Labels', 'tabs' => [
                ['slug' => 'label/blog-category', 'label' => 'Blog Categories', 'icon' => 'tag'],
            ]],

            ['group' => 'Website', 'tabs' => [
                ['slug' => 'website/profile', 'label' => 'Profile', 'icon' => 'globe'],
                ['slug' => 'website/seo', 'label' => 'SEO', 'icon' => 'search'],
                ['slug' => 'website/analytics', 'label' => 'Analytics', 'icon' => 'chart-simple'],
                ['slug' => 'website/social-media', 'label' => 'Social Media', 'icon' => 'share-nodes'],
                ['slug' => 'website/announcement', 'label' => 'Announcement', 'icon' => 'bullhorn'],
                ['slug' => 'website/popup', 'label' => 'Pop-Up', 'icon' => 'window-restore'],
            ]],

            ['group' => 'Integration', 'tabs' => [
                ['slug' => 'integration/email', 'label' => 'Email', 'icon' => 'paper-plane'],
                ['slug' => 'integration/storage', 'label' => 'Storage', 'icon' => 'hard-drive'],
                ['slug' => 'integration/payment', 'label' => 'Payment', 'icon' => 'money-bill'],
                ['slug' => 'integration/social-login', 'label' => 'Social Login', 'icon' => 'login'],
            ]]
        ];
    }
}

1. Alternatively, you can publish the whole app/settings to local.

php artisan atom:publish app.settings

Payment Gateway

1. To enable payment gateway, add the provider in config/atom.php

// config/atom.php
...
'payment_gateway' => ['ozopay'];

1. Exclude the redirect and webhook route from CSRF checking.

// app/Http/Middleware/VerifyCsrfToken.php

protected $exclude = [
    '__ozopay/*',
    '__gkash/*',
    '__stripe/*',
];

1. Configure config/session.php same site settings to null. This is to allow POST from another provider.

// config/session.php
...
'same_site' => null,

1. Use the payment gateway component to show the payment method selection box.

<x-payment-gateway
    callback="createPayment"
    :providers="['ozopay']"
    :endpoints="[
        'ozopay' => 'https://uatpayment.ozopay.com/PaymentEntry/PaymentOption',
    ]"
    :value="[
        'email' => $contribution->socso_account->email,
        'phone' => $contribution->socso_account->phone,
        'address' => implode(', ', [$contribution->socso_account->address_1, $contribution->socso_account->address_2]),
        'city' => $contribution->socso_account->city,
        'postcode' => $contribution->socso_account->postcode,
        'state' => metadata()->socso('state', $contribution->socso_account->state),
        'country' => 'MY',
        'currency' => 'MYR',
        'amount' => $this->total,
    ]"
/>

1. Create a fulfillment job in app/Jobs for each provider. Below are the class name for each providers:
   • Ozopay: app/Jobs/OzopayFulfillment.php

// app/Jobs/OzopayFulfillment.php

...
protected $params; // will contains the response from provider

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

public function handle()
{
    // handle fulfillment
}