TallUI Monorepo

This is the TallUI Monorepo containing all packages and the Laravel dev app.

Packages

TallUI packages are categorized in

• _components - Laravel packages only packed with Blade and Livewire components
• _data - Laravel packages only used as data-provider (model, migration, seeding)
• _icons - Laravel packages only with SVG icons, compatible with Blade Icons
• _others - Other Laravel packages or assisting repos like TallUI Package Builder
• _packages - Full blown Laravel packages like TallUI Core or Admin Panel
• _themes - Themes for the admin (backend) or website (frontend)
• _themes/website - Themes for the TallUI Website

Packages are automatically updated to their own read-only repos when pushed to [main].

Add a new package:

• Create a new package from TallUI Package Builder template
• Copy contents into one of the _subfolder of the monorepo
• Add the package to the appropriate monorepo-split-action
• Add the package to _custom/composer.json-example and composer-tests.json
• Add the package to the README.md in the appropriate _subfolder
• Add the package to _app/***/composer.json, if the package is stable

Installation

The Laravel dev app is made for instant development with Laravel Sail or Laragon.

# Use the prepared composer.json
cp _custom/composer.json-example _custom/composer.json

# Use the matching environment for sail or laragon
cp .env.sail .env
cp .env.laragon .env

# Build
composer install

# Run Sail, alternatively start Laragon
./vendor/bin/sail up

# Run Vite (in Ubuntu, not in Sail container)
npm install
npm run dev

# Rebuild the sail config if needed
./vendor/bin/sail down --rmi all -v
php artisan sail:install

# Remove broken symlinks 
# switching from Laragon to Sail for example
rm -Rf vendor/usetall

Custom

As you might want to develop with a custom set of TallUI packages or require your own packages, we included a second composer.json. This composer-file requires all TallUI packages and can be easily edited or extended without overwriting the main composer.json.

cd _custom
cp composer.json-example composer.json

To customize the set of TallUI packages, simply delete the packages you don't want to load from the require-section, composer update afterwards.

If you want to include custom packages you can clone one or more packages as subrepos into _custom and add them to _custom/composer.json like so:

    "repositories": [
        {
            "type": "path",
            "url": "./_custom/package"
        }
    ],
    "require": {
        "custom/package": "dev-main"
    },

Development

• Do npm run build before committing because automated tests on GitHub needs a working vite-manifest
• Do php artisan migrate --database=sqlite to reflect changes to the test-database
• Use https://marketplace.visualstudio.com/items?itemName=adrolli.tallui-laravel-livewire-tailwind with VS Code
• Use https://github.com/usetall/tallui-package-builder to create your own packages
• Please see CONTRIBUTING for details.

Branching

• main is the current stable version, branch-protected, auto-commits to all packages, deployed live
• test is the branch for tests and Scrutinizer, deployed on staging, merged to main
• dev active development with tests and code fixing, merged to test
• feature/... prefix all other dev-branches, merge to dev

Testing

We test TallUI using:

• Monorepo
  • Larastan, PHPStan Level 5
  • Laravel Pint, PHP CS Fixer
  • Cypress
• Packages
  • Orchestra Testbench
  • Larastan, PHPStan Level 5
  • Laravel Pint, PHP CS Fixer
  • Laravel Dusk
  • Pest
  • Scrutinizer
  • Coverage > 75%

Please make sure you use the same tools in VS Code, our VS Code Extension Pack covers this. Or do the checks manually like so:

• Use PHPStan before committing: ./vendor/bin/phpstan analyse, from a package: ../../vendor/bin/phpstan analyse
• Run Pest before committing: ./vendor/bin/pest, from a package: ../../vendor/bin/pest
• Run Pint before commiting: ./vendor/bin/pint, you guess it: ../../vendor/bin/pint

Todo

• https://github.com/usetall/tallui/blob/main/CONTRIBUTION.md

• App Components README.md -> others + builder

• Larastan, Cypress and more testing

  • https://github.com/adrolli/test-repo/ (from actual builder) runs with coverage, components can be tested now
    • https://laravel-livewire.com/screencasts/s1-writing-tests
    • https://spatie.be/courses/testing-laravel-with-pest/testing-a-livewire-component
    • https://github.com/livewire/livewire/blob/master/tests/Browser/TestCase.php
    • Badges, Coverage, README
  • Fix TestCase in tallui-core, phpstan in app-components and tests for livewire in app-components / web-components
  • Use Pest main with all packages + coverage + min:75%
  • Create test output in app, test output in app AS WELL AS test plain component in package
  • https://dev.to/robertobutti/add-test-coverage-badge-for-php-and-pest-in-your-github-repository-37mo - easy but not enough, how to calc coverage over a bunch of test?
  • https://pestphp.com/docs/coverage
  • use test-directory, see pestphp/pest#283
  • or run tests with testbench like inside the packages
  • use https://pestphp.com/docs/plugins/laravel and https://pestphp.com/docs/plugins/livewire
  • use Laravel Dusk https://laravel.com/docs/9.x/dusk
  • and/or Cypress for Browsertests (https://dashboard.cypress.io/projects/ch1wnj/runs // https://github.com/laracasts/cypress / https://laracasts.com/series/jeffreys-larabits/episodes/22)
  • maybe use https://github.com/danielpalme/ReportGenerator-GitHub-Action as Coverage UI oder codecov.io

• Improve builder

  • Finish testing by creating a set of simple tests incl.
    • the blade component
    • the livewire component
    • asset loading
    • service provider itself?

• _builder

  • Module Builder
  • Iconset Builder
  • Component Builder
  • Theme Builder
  • Package Builder

• Care for translations (add to all packages / builder?)

  • https://laravel.com/docs/9.x/localization
  • https://laravel-news.com/laravel-lang-translations
  • https://blog.quickadminpanel.com/10-best-laravel-packages-for-multi-language-translations/
  • https://hosted.weblate.org/projects/tallui/ + https://libretranslate.com/

• Scaffold website-package to output all components

• Scaffold admin-package

• Start with Dashboard and Tailwind conf (https://tailwindcss.com/docs/theme, see Theme-docs)

• Create Coming Soon page

• Get all packages running in composer

• Wire the full-app with composer

• Rebuild icons-package with Workflows, add to builder?

• Deploy it on Vapor, Cloudways and Shared Hosting

• Save the icons, dev-components, docs and other stuff

Ideas

Blade / Livewire-Components class=“ your_class“ => append attributes to default styles or theme styles :class=”your_class” => overwrite all default styles and theme styles

See: https://laracasts.com/discuss/channels/livewire/scoped-css-in-livewire-component https://laravel.com/docs/9.x/blade#passing-data-to-components https://laravel-livewire.com/docs/2.x/properties

Check https://tailwindcss.com/blog/tailwindcss-v3-2?utm_source=newsletter&utm_medium=email&utm_campaign=tailwind_v32_release_open_graph_image_generation_and_nextjs_conf_is_coming&utm_term=2022-10-20#multiple-config-files-in-one-project-using-config

• Sicherheitsfrage(n) oder z. B. Geburtsdatum - auch bei Zurücksetzen Mail
• Anmeldelink per Mail
• 3FA
• Datenschutz - automatische Löschung inaktiver Konten nach XX Tagen, Mail an Kunde zuvor - Grace period (Deaktivierung)

https://kutty.netlify.app/components/ - free TailwindCSS and AlpineJS Components

https://flowbite.com/ - commercial, only TailwindCSS, own JS-Lib

https://www.tailwindawesome.com/?price=free&technology=5

https://rappasoft.com/blog/a-sneak-peak-at-livewire-tables-v2

https://github.com/nunomaduro/larastan

https://github.com/devicons/devicon

https://github.com/miten5/larawind

https://github.com/spatie/laravel-translatable

https://accessible-colors.com/

https://razorui.com/pricing

https://github.com/vildanbina/livewire-wizard

https://laravel-news.com/migrator-gui-migration-manager-for-laravel

Package Builder

• ServiceProvider - YEP
• Blade Component - YEP
• Livewire Component
• Custom Command
• Views (Blade / Livewire)
• Route
• Model
• Migration
• Seeder
• Middleware
• Facade
• Trait
• Controller
• Notification
• Exception
• Languages
• Jobs
• Config
• Faker
• Docs
• Tests
• Theme / Assets (Storage)

todos:

• rename to pgkname-blade-component
• pgkname-livewire-component
• assets
  • js mit ausgabe
  • css mit sichbarkeit
• tests für komponenten + assets

What the PHPStan?????

• Unterschiede Büro / Home?!?
• https://github.com/nunomaduro/larastan/blob/master/docs/custom-types.md