ttall - GitLite

KO | EN

gitlite — search

#javascript #hacktoberfest #ai #golang #rust #deep-learning #macos #nodejs #cli #kubernetes #awesome-list #vue #pytorch #openai

ttall

(★ 52)

Laravel fronend preset for TTALL stack - Tailwindcss | Turbolinks | Alpine.js | Laravel | Livewire 🚀

File Explorer

Download Latest Version (.zip)

- - phpunit.xml.stub
  - tests.yml
- screen-record.gif
- HandlesAuthScaffolding.php
- HandlesCodeHelperScaffolding.php
- HandlesGeneralScaffolding.php
- TtallPreset.php
- TtallPresetServiceProvider.php
.gitignore
.php-cs-fixer.php
composer.json
LICENSE
phpstan.neon
README.md

# Installation Guide

1. Get the code

git clone https://github.com/pktharindu/ttall

Downloads the entire project code from GitHub to your computer.

cd ttall

Moves into the project folder you just downloaded.

2. PHP (Composer)

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
PHP A PHP runtime is required.
Composer The package manager used to install PHP libraries.

Finally run `composer update && npm install && npm run dev` to install the new composer packages and compile your fresh scaffolding.

Downloads and installs the libraries listed in package.json.

- Composer Git Hooks

Type this command into your terminal and run it.

A composer's script is added automatically to tell `Laravel IDE Helper` to rescan your `Facades` files and update git hooks after every `composer update` :

Type this command into your terminal and run it.

✅ Run it with a built-in server like php -S localhost:8000, then open http://localhost:8000 in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# TTALL Preset For Laravel 7 and Up

[![License: MIT](https://img.shields.io/badge/license-MIT-green)](https://raw.githubusercontent.com/pktharindu/ttall/master/LICENSE)
[![CI Status](https://github.com/pktharindu/ttall/workflows/tests/badge.svg)](https://github.com/pktharindu/ttall/actions)
[![Total Downloads](https://poser.pugx.org/pktharindu/ttall/d/total.svg)](https://packagist.org/packages/pktharindu/ttall)

An opinionated Laravel front-end scaffolding preset for TTALL stack - Tailwindcss | Turbolinks | Alpine.js | Laravel | Livewire 🚀

It comes bundled with some helpful packages and their configurations (optional):

It uses concerns of [laravel/ui](https://github.com/laravel/ui) through Livewire actions. So, security features of laravel/ui (ex: login throttling) are built right in. It also comes bundled with some helpful packages and their configurations (optional):

- Laravel debugbar
- Laravel IDE Helper
- Php CS Fixer
- Larastan
- Eslint (Airbnb rules)
- Prettier
- Composer Git Hooks

![Screen Record](https://raw.githubusercontent.com/pktharindu/ttall/master/screenshots/screen-record.gif)

If you like this package, show some love by starring the repo. ⭐❤

## Contents

- [TTALL Preset For Laravel 7 and Up](#ttall-preset-for-laravel-7-and-up)
  - [Contents](#contents)
  - [Installation](#installation)
    - [For Basic Presets (without authentication)](#for-basic-presets-without-authentication)
    - [For Presets with Authentication](#for-presets-with-authentication)
  - [Configuration](#configuration)
  - [Options](#options)
    - [Code Helpers](#code-helpers)
      - [Scripts](#scripts)
  - [Support](#support)
  - [Credits](#credits)
  - [License](#license)

## Installation

To install this preset on your laravel application, run:

``` bash
composer require pktharindu/ttall --dev
```

### For Basic Presets (without authentication)

To scaffold the basic preset without authentication, run:
``` bash
php artisan ui ttall
```

### For Presets with Authentication

To scaffold the basic preset, auth route entry and auth views in one go, run:
``` bash
php artisan ui ttall --auth
```
Finally run `composer update && npm install && npm run dev` to install the new composer packages and compile your fresh scaffolding.

## Configuration

Add a new i18n string in the `resources/lang/XX/pagination.php` file for each language that your app uses:

```php
'previous' => '&laquo; Previous',
'next' => 'Next &raquo;',
'goto_page' => 'Goto page #:page', // Add this line
```

This will help with accessibility.

```html
<li>
  <a href="URL?page=2" class="..." aria-label="Goto page #2">
    2
  </a>
</li>
```

## Options

As this preset is designed to get you up-and-running quickly, it comes bundled with some extra options that will take you even further. To utilize these options, use the `--option` flag when installing the preset.

Usage Example:

```bash
php artisan ui ttall --option=code-helpers
```

### Code Helpers

`code-helpers` option will install and configure the below packages to help you with the development:

- Laravel debugbar
- Laravel IDE Helper
- Php CS Fixer
- Larastan
- Eslint (Airbnb rules)
- Prettier
- Composer Git Hooks

#### Scripts

A composer's script is added automatically to tell `Laravel IDE Helper` to rescan your `Facades` files and update git hooks after every `composer update` :

```json
"scripts": {
    "post-update-cmd": [
        "Illuminate\\Foundation\\ComposerScripts::postUpdate",
        "@php artisan ide-helper:generate",
        "cghooks update"
    ]
}
```

Also, Git Hooks are added to format your php files automatically before each commit.

```json
"extra": {
    "hooks": {
        "pre-commit": [
            "STAGED_FILES=$(git diff --cached --name-only --diff-filter=ACM -- '*.php')",
            "php-cs-fixer fix",
            "git add $STAGED_FILES"
        ]
    }
},
```

Scripts are also added to your `package.json` and `composer.json` to run specific actions :

- `composer format` : will use `php-cs-fixer` to format your php files
- `composer test` : will use the `php artisan test` command to run your phpunit tests
- `composer analyse` : will use `larastan` to analyse your code
- `npm run format` : will format your js files on `resources/js` folder
- `npm run lint` : will find issues in your js files based on Airbnb's rules and try to fix them

## Support

If you require any support please contact me on [Twitter](https://twitter.com/CallMeTharindu) or open an issue on this repository.

## Credits

- [P. K. Tharindu](https://github.com/pktharindu)
- [All Contributors](../../contributors)

This Package is inspired by [laravel-frontend-presets/tall](https://github.com/laravel-frontend-presets/tall) and [YannickYayo/laravel-preset-ttall](https://github.com/YannickYayo/laravel-preset-ttall). I wanted to have a combination of both. Thanks to all authors of these packages.

## License

Licensed under the MIT license, see [LICENSE](/LICENSE) for details.