WIP

stephenjude · Feb 29, 2024 · 99e6e8d · 99e6e8d
1 parent 39d7748
commit 99e6e8d
Show file tree

Hide file tree

Showing 10 changed files with 39 additions and 33 deletions.
diff --git a/README.md b/README.md
@@ -1,11 +1,19 @@
-# Laravel Jetstream adapter for Filament Admin Panels
+# Filament Jetstream
 
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/stephenjude/filament-jetstream.svg?style=flat-square)](https://packagist.org/packages/stephenjude/filament-jetstream)
 [![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/stephenjude/filament-jetstream/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/stephenjude/filament-jetstream/actions?query=workflow%3Arun-tests+branch%3Amain)
 [![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/stephenjude/filament-jetstream/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/stephenjude/filament-jetstream/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
 [![Total Downloads](https://img.shields.io/packagist/dt/stephenjude/filament-jetstream.svg?style=flat-square)](https://packagist.org/packages/stephenjude/filament-jetstream)
 
-This package adapts Laravel Jetstream Livewire into your filament admin panel, and it supports team, api and dark mode.
+This package natively installs all the [Laravel Jetstream](https://jetstream.laravel.com/) features into your Filament
+application. Just like Laravel Jetstream, this package should only be installed on afresh Laravel application. You don't
+need to install Livewire, Jetstream or Filament before using this package. It does all the work for you!
+
+## How It Wokrs
+
+This package did not reinvent the wheel. Under the hood, it uses all the Livewire components from Laravel Jetstream
+and removes anything that is not needed. You can enable or disable features from the Jetstream config, and it works on
+Filament too.
 
 ## Installation
 
@@ -15,34 +23,38 @@ You can install the package via composer:
 composer require stephenjude/filament-jetstream
 ```
 
-Install Jetstream with team, api and email verification.
-```php
-php artisan filament:jetstream:install --teams --api --verification
+## Install Jetstream With Teams And API Features
+
+```shell
+php artisan filament:jetstream:install --teams --api
 ```
 
-You can publish the config file with:
+You can remove the `--teams` and `--api` arguments if you don't want those features.
 
-```bash
-php artisan vendor:publish --tag="filament-jetstream-config"
-```
+## Screenshots
 
-Optionally, you can publish the views using
+![Edit Profile](art/profile_1.png)
 
-```bash
-php artisan vendor:publish --tag="filament-jetstream-views"
-```
+---
 
-This is the contents of the published config file:
+![Edit Profile](art/profile_2.png)
 
-```php
-return [
-];
-```
+---
+
+![Edit Team](art/team_1.png)
+
+---
+
+![Edit Team](art/team_2.png)
+
+---
 
-## Usage
+![Edit Team](art/api_token.png)
 
-```php
-php artisan 
+You can publish the config file with:
+
+```bash
+php artisan vendor:publish --tag="filament-jetstream-config"
 ```
 
 ## Testing
@@ -66,6 +78,7 @@ Please review [our security policy](../../security/policy) on how to report secu
 ## Credits
 
 - [stephenjude](https://github.com/stephenjude)
+- [taylorotwell](https://github.com/taylorotwell)
 - [All Contributors](../../contributors)
 
 ## License

diff --git a/art/api_token.png b/art/api_token.png
diff --git a/art/profile_1.png b/art/profile_1.png
diff --git a/art/profile_2.png b/art/profile_2.png
diff --git a/art/team_1.png b/art/team_1.png
diff --git a/art/team_2.png b/art/team_2.png
diff --git a/config/filament-jetstream.php b/config/filament-jetstream.php
@@ -1,16 +1,9 @@
 <?php
 
-// config for FilamentJetstream/FilamentJetstream
 return [
-
-    /*
-     * Disable Jetstream and Fortify routes. If you want your users to still used
+    /**
+     * Display, hide and sort user's navigation items from this package
      */
-    'enable_route' => [
-        'fortify' => true,
-        'jetstream' => false,
-    ],
-
     'navigation_items' => [
         'profile' => [
             'display' => false,

diff --git a/src/Pages/ApiTokens.php b/src/Pages/ApiTokens.php
@@ -19,6 +19,6 @@ public static function shouldRegisterNavigation(): bool
 
     public static function getNavigationSort(): ?int
     {
-        return (bool) config('filament-jetstream.navigation_items.api_token.sort');
+        return config('filament-jetstream.navigation_items.api_token.sort');
     }
 }
diff --git a/src/Pages/EditProfile.php b/src/Pages/EditProfile.php
@@ -19,6 +19,6 @@ public static function shouldRegisterNavigation(): bool
 
     public static function getNavigationSort(): ?int
     {
-        return (bool)config('filament-jetstream.navigation_items.profile.sort');
+        return config('filament-jetstream.navigation_items.profile.sort');
     }
 }
diff --git a/src/Pages/EditTeam.php b/src/Pages/EditTeam.php
@@ -30,6 +30,6 @@ public static function shouldRegisterNavigation(): bool
 
     public static function getNavigationSort(): ?int
     {
-        return (bool) config('filament-jetstream.navigation_items.team.sort');
+        return config('filament-jetstream.navigation_items.team.sort');
     }
 }