Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zofe/rapyd-livewire
rapyd: crud widgets for laravel. datatable, grids, forms, in a simple package
https://github.com/zofe/rapyd-livewire
crud laravel livewire livewire-components modules rapyd
Last synced: 3 months ago
JSON representation
rapyd: crud widgets for laravel. datatable, grids, forms, in a simple package
- Host: GitHub
- URL: https://github.com/zofe/rapyd-livewire
- Owner: zofe
- License: mit
- Created: 2022-03-18T21:13:12.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-05-24T15:24:49.000Z (over 1 year ago)
- Last Synced: 2024-10-01T09:23:15.798Z (3 months ago)
- Topics: crud, laravel, livewire, livewire-components, modules, rapyd
- Language: PHP
- Homepage:
- Size: 15.9 MB
- Stars: 34
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# rapyd-livewire
[](https://rapyd.dev/demo)
requirements: laravel ^8.65 | 9.* | 10.*
Demo: [rapyd.dev](https://rapyd.dev/demo)
## What is it?
is a laravel library of **blade components**, **livewire traits**, and **modules** scaffolder that you can use to generate
administration interfaces in a concise, reusable, uncluttered, and testable manner.
It also bundles standard frontend libraries like
Bootstrap, Vue, Alpine, Tom Select and Quill to be used as fast boilerplate for your laravel admin panels.
The idea is to speed up and organize the development of large laravel applications:
- **modular approach** (you can organize your backends into reusable modules, isolating everything, components, views, tests, but also translations, migrations, jobs, each module can be like an isolated laravel application)
- **livewire component** based (no needed controllers, each component is naturally reactive, you can get away with few pure livewire classes and blade views, easily testable and maintainable)
- **blade component** based (dozens of available anonymous components to standardize frontend in few "bootstrap based" spacialized tags, which you can eventually extend)
## Modules
example of out of the box module structure you can use after installing rapyd.
- You can create "Modules" folder in you app/ directory of your laravel application.
- Then you can create your Module Folder i.e.: `Blog`
- Livewire components will be searched in the `Components` subfolder
- You can refer to the views in your module using intuitive shortcut i.e.: `blog::Articles.views.articles_edit`
- Inside your Module folder you can reply (if needed) the laravel application folder structure (controllers, migrations, jobs, etc..)
```
laravel/
├─ app/
│ ├─ Modules/
│ │ ├─ Blog/
│ │ │ ├─ Components/
│ │ │ │ ├─ Articles/
│ │ │ │ │ ├─ views/
│ │ │ │ │ │ ├─ articles_edit.blade.php
│ │ │ │ │ │ ├─ articles_table.blade.php
│ │ │ │ │ │ ├─ articles_view.blade.php
│ │ │ │ │ ├─ ArticlesEdit.php
│ │ │ │ │ ├─ ArticlesTable.php
│ │ │ │ │ ├─ ArticlesView.php
│ │ │ │ ├─ routes.php
```
Rapyd has also some public modules available via "composer require":
* [zofe/demo-module](https://github.com/zofe/demo-module) demo
* [zofe/knowledgebase-module](https://github.com/zofe/knowledgebase-module) knowledgebase
* [zofe/auth-module](https://github.com/zofe/auth-module) auth
* [zofe/layout-module](https://github.com/zofe/layout-module) layout
Rapyd has a "module installer": [zofe/rapyd-module-installer](https://github.com/zofe/rapyd-module-installer)
this means that you can plan to create & distribute your modules as packages including it as dependency and following a simple naming convention, for example with a composer.json file like this:
```
{
"name": "yourname/mymodule-module",
"description": "my custom module for laravel application",
"license": "mit",
"type": "rapyd-module",
"authors": [
{
"name": "Me",
"email": "[email protected]"
}
],
"require": {
"php": "^7.4|^8.0|^8.1|^8.2",
"illuminate/config": "^8.65|^9.0|^10.0",
"illuminate/contracts": "^8.65|^9.0|^10.0",
"livewire/livewire": "^2.0",
"zofe/rapyd-livewire": "dev-main|^0.8",
"zofe/rapyd-module-installer": "^0.0|^0.1",
"zofe/layout-module": "dev-main|^0.0|^0.1"
},
"config": {
"allow-plugins": {
"zofe/rapyd-module-installer": true
}
},
"minimum-stability": "dev",
"prefer-stable": true
}
```
then you can include your own modules using composer require "yourname/mymodule-module" and this will install your dependency in
`app/Modules/Mymodule`
Please check for example [zofe/knowledgebase-module](https://github.com/zofe/knowledgebase-module) knowledgebase module to get an idea of how to structure it.
## Installation
You can install the package via composer:
```bash
composer require zofe/rapyd-livewire
```
You can publish static assets using:
```bash
php artisan vendor:publish --provider="Zofe\Rapyd\RapydServiceProvider" --tag="public"
```
if you want you can download the demo module in your laravel-rapyd application try the [zofe/demo-module](https://github.com/zofe/demo-module)
## Usage
---
### DataTable
A DataTable is a "listing component" with these features:
- "input filters" to search in a custom data set
- "buttons" (for example "add" record or "reset" filters)
- "pagination links"
- "sort links"
```html
title
author
body
@foreach ($items as $article)
{{ $article->id }}
{{ $article->title }}
{{ $article->author->firstname }}
{{ Str::limit($article->body,50) }}
@endforeach
```
props
- `title`: the heading title for this crud
content/slots
- should be a html table that loops model $items
- `buttons`: buttons panel
example: [rapyd.dev/demo/articles](https://rapyd.dev/demo/articles)
---
### DataView
a DataView is a "detail page component" with :
- "buttons" slot (for example back to "list" or "edit" current record)
- "actions" any link that trigger a server-side
```html
Title: {{ $article->title }}
Author: {{ $article->author->firstname }} {{ $model->author->lastname }}
```
props
- `title`: the heading title for this crud
content/slots
- should be a detail of $model
- `buttons`: buttons panel
- `actions`: buttons panel
example: [rapyd.dev/demo/article/view/1](https://rapyd.dev/demo/article/view/1)
---
### DataEdit
DataEdit is a "form component" usually binded to a model with:
- "buttons" and "actions" (undo, save, etc..)
- form "fields"
- automatic errors massages / rules management
```html
```
props
- `title`: the heading title for this crud
content/slots
- form fields binded with public/model properties
example: [rapyd.dev/demo/article/edit/1](https://rapyd.dev/demo/article/edit/1)
---
### Fields
inside some widget views you can drastically semplify the syntax using
predefined blade components that interacts with livewire
```html
```
```html
```
```html
or
```
```html
```
```html
```
```html
```
props
- `label`: label to display above the input
- `placeholder`: placeholder to use for the empty first option
- `model`: Livewire model property key
- `options`: array of options e.g. (used in selects)
- `debounce`: Livewire time in ms to bind data on keyup
- `lazy`: Livewire bind data only on change
- `prepend`: addon to display before input, can be used via named slot
- `append`: addon to display after input, can be used via named slot
- `help`: helper label to display under the input
- `icon`: Font Awesome icon to show before input e.g. `cog`, `envelope`
- `size`: Bootstrap input size e.g. `sm`, `lg`
- `rows`: rows nums
- `multiple`: allow multiple option selection (used in select-list)
- `endpoint`: a remote url for fetch optioms (used in select-list)
- `format`: the client-side field format (used in date and date-time)
- `value-format`: the server-side field value format (used in date and date-time)
## special tags
```html
```
## navigation
Nav Tabs: bootstrap nav-link menu with self-determined active link
```html
```
Nav Items: boostrap vertical menu items / single or grouped (collapsed)
```html
```
Nav Sidebar: bootstrap sidebar with self-determined or segment-based active link
```html
```
## minimal application layout
there are some css/js dependencies (livewire, bootstrap, alpinejs, vuejs)
but rapyd has two directive to simplify all needed inclusions.
Consider to use `{{ $slot }}` as entry-point if you plan to use
[Full-page components](https://laravel-livewire.com/docs/2.x/rendering-components#page-components)
don't forget to add "app" class to your main div if you plan to use vuejs components
```html
@rapydLivewireStyles
{{ $slot ??'' }}
@rapydLivewireScripts
```
## layout module
If you want to isolate the layout as well and make it a module, reusable in multiple projects, rapyd does that as well, and it has a default module that you can customize or take as an example:
* [zofe/layout-module](https://github.com/zofe/layout-module) layout module
## To-do
- component generators (with custom stub for DataTable,DataEdit,DataView)
- "plugin" architecture (a way to download a module from a public or private repository.. or just a composer way to deploy in app/Modules)
## Credits
- [Felice Ostuni](https://github.com/zofe)
- [All Contributors](../../contributors)
Inspirations:
- [rapyd-laravel](https://github.com/zofe/rapyd-laravel) my old laravel library (150k downloads)
- [livewire](https://laravel-livewire.com/) widely used "full-stack framework" to compose laravel application by widgets
- [laravel-bootstrap-components](https://github.com/bastinald/laravel-bootstrap-components) smart library which reduced the complexity of this one
## License & Contacts
Rapyd is licensed under the [MIT license](http://opensource.org/licenses/MIT)
Please join me and review my work on [Linkedin](https://www.linkedin.com/in/feliceostuni/)
thanks