3 |
2 |
3 |
6 | 7 | [](https://packagist.org/packages/lara-zeus/core) 8 | [](https://packagist.org/packages/lara-zeus/wind) 9 | [](https://github.com/lara-zeus/wind/actions?query=workflow%3Arun-tests+branch%3Amain) 10 | [](https://github.com/lara-zeus/wind/actions?query=workflow%3Afix-php-code-style-issues+branch%3Amain) 11 | [](https://packagist.org/packages/lara-zeus/wind) 12 | [](https://github.com/lara-zeus/wind) 13 | 14 |
15 | 16 |
25 |
26 |
27 | ## Features
28 | - 🔥 built with [TALL stack](https://tallstack.dev/)
29 | - 🔥 using [filament](https://filamentadmin.com) as an admin panel
30 | - 🔥 optionally you can add categories to the contact form like 'sales','dev','report bug' etc.
31 | - 🔥 you can add logos for all categories.
32 | - 🔥 direct URL to contact on specific category.
33 |
34 | ## Demo
35 |
36 | > visit our website to get the full documentation: https://larazeus.com/wind
37 |
38 | > real use: https://larazeus.com/contact-us
39 |
40 | ## Installation
41 |
42 | You can install the package via composer:
43 |
44 | ```bash
45 | composer require lara-zeus/wind
46 | ```
47 |
48 | run the command:
49 |
50 | ```bash
51 | php artisan wind:publish
52 | ```
53 |
54 | ## Usage
55 |
56 | visit the url `/admin` to manage the Letters, and `/contact-us` to access the contact form.
57 |
58 | ## Full Documentation
59 |
60 | > visit our website to get the full documentation: https://larazeus.com/wind
61 |
62 | ## Quick start
63 |
64 | [](https://github.com/lara-zeus/zeus)
65 | [](https://github.com/lara-zeus/artemis)
66 |
67 | ## Changelog
68 |
69 | Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
70 |
71 | ## Support
72 |
73 | available support channels:
74 | * open an issue on [GitHub](https://github.com/lara-zeus/wind/issues)
75 | * email us using the [contact center](https://larazeus.com/contact-us)
76 |
77 | ## Contributing
78 |
79 | Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
80 |
81 | ## Security
82 |
83 | If you discover any security related issues, please email info@larazeus.com instead of using the issue tracker.
84 |
85 | ## Credits
86 |
87 | - [Lara Zeus (Ash)](https://github.com/atmonshi)
88 | - [All Contributors](../../contributors)
89 |
90 | ## License
91 |
92 | The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
93 |
--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "lara-zeus/wind",
3 | "description": "Zeus Wind is simple contact form for your website with easy to use dashboard, works as a plugin for Filament Admin Panel",
4 | "keywords": [
5 | "laravel",
6 | "lara-zeus",
7 | "contact",
8 | "form",
9 | "forms",
10 | "mailing",
11 | "filamentphp"
12 | ],
13 | "homepage": "https://larazeus.com/wind",
14 | "support": {
15 | "issues": "https://github.com/lara-zeus/wind/issues",
16 | "source": "https://github.com/lara-zeus/wind"
17 | },
18 | "license": "MIT",
19 | "type": "library",
20 | "authors": [
21 | {
22 | "name": "Lara Zeus (Ash)",
23 | "email": "info@larazeus.com"
24 | }
25 | ],
26 | "require": {
27 | "php": "^8.1",
28 | "lara-zeus/core": "^3.2"
29 | },
30 | "require-dev": {
31 | "phpunit/phpunit": "^10.1",
32 | "nunomaduro/collision": "^7.0",
33 | "pestphp/pest-plugin-livewire": "2.x-dev",
34 | "phpstan/phpstan-deprecation-rules": "^1.0",
35 | "phpstan/phpstan-phpunit": "^1.0",
36 | "laravel/pint": "^1.0",
37 | "larastan/larastan": "^2.2",
38 | "orchestra/testbench": "^8.0",
39 | "pestphp/pest": "^2.0",
40 | "pestphp/pest-plugin-laravel": "^2.0",
41 | "phpstan/extension-installer": "^1.1",
42 | "phpstan/phpstan": "^1.10"
43 | },
44 | "autoload": {
45 | "psr-4": {
46 | "LaraZeus\\Wind\\": "src"
47 | }
48 | },
49 | "autoload-dev": {
50 | "psr-4": {
51 | "LaraZeus\\Wind\\Tests\\": "tests"
52 | }
53 | },
54 | "scripts": {
55 | "pint": "vendor/bin/pint",
56 | "test:pest": "vendor/bin/pest --parallel",
57 | "test:phpstan": "vendor/bin/phpstan analyse",
58 | "test": [
59 | "@test:pest",
60 | "@test:phpstan"
61 | ]
62 | },
63 | "config": {
64 | "sort-packages": true,
65 | "allow-plugins": {
66 | "pestphp/pest-plugin": true,
67 | "phpstan/extension-installer": true,
68 | "dealerdirect/phpcodesniffer-composer-installer": true
69 | }
70 | },
71 | "minimum-stability": "dev",
72 | "extra": {
73 | "laravel": {
74 | "providers": [
75 | "LaraZeus\\Wind\\WindServiceProvider"
76 | ]
77 | }
78 | }
79 | }
80 |
--------------------------------------------------------------------------------
/database/factories/DepartmentFactory.php:
--------------------------------------------------------------------------------
1 | getModel('Department');
13 | }
14 |
15 | public function definition(): array
16 | {
17 | return [
18 | 'name' => $this->faker->words(3, true),
19 | 'ordering' => $this->faker->numberBetween(1, 10),
20 | 'is_active' => $this->faker->numberBetween(0, 1),
21 | 'desc' => $this->faker->words(5, true),
22 | 'slug' => $this->faker->slug,
23 | ];
24 | }
25 | }
26 |
--------------------------------------------------------------------------------
/database/factories/LetterFactory.php:
--------------------------------------------------------------------------------
1 | getModel('Department');
14 | }
15 |
16 | public function definition(): array
17 | {
18 | return [
19 | 'name' => $this->faker->name,
20 | 'email' => $this->faker->email,
21 | 'department_id' => Department::factory(),
22 | 'title' => $this->faker->words(3, true),
23 | 'message' => $this->faker->words(5, true),
24 | 'status' => 'NEW',
25 | ];
26 | }
27 | }
28 |
--------------------------------------------------------------------------------
/database/migrations/alter_letters_constraints.php.stub:
--------------------------------------------------------------------------------
1 | dropForeign(['department_id']);
19 | Schema::enableForeignKeyConstraints();
20 |
21 | $table->foreign('department_id')
22 | ->onUpdate('cascade')
23 | ->onDelete('cascade')
24 | ->references('id')
25 | ->on('departments');
26 | });
27 | }
28 |
29 | /**
30 | * Reverse the migrations.
31 | *
32 | * @return void
33 | */
34 | public function down()
35 | {
36 |
37 | }
38 | };
39 |
--------------------------------------------------------------------------------
/database/migrations/create_department_table.php.stub:
--------------------------------------------------------------------------------
1 | id();
18 | $table->string('name');
19 | $table->integer('ordering')->default(1);
20 | $table->boolean('is_active')->default(0);
21 | $table->text('desc')->nullable();
22 | $table->string('slug');
23 | $table->string('logo')->nullable();
24 | $table->timestamps();
25 | $table->softDeletes();
26 | });
27 | }
28 |
29 | /**
30 | * Reverse the migrations.
31 | *
32 | * @return void
33 | */
34 | public function down()
35 | {
36 | Schema::dropIfExists('departments');
37 | }
38 | };
39 |
--------------------------------------------------------------------------------
/database/migrations/create_letters_table.php.stub:
--------------------------------------------------------------------------------
1 | id();
18 | $table->string('name');
19 | $table->string('email');
20 | $table->foreignId('department_id')->nullable()->constrained();
21 | $table->string('title');
22 | $table->text('message');
23 | $table->string('status')->default('NEW');
24 | $table->string('reply_title')->nullable();
25 | $table->text('reply_message')->nullable();
26 | $table->timestamps();
27 | $table->softDeletes();
28 | });
29 | }
30 |
31 | /**
32 | * Reverse the migrations.
33 | *
34 | * @return void
35 | */
36 | public function down()
37 | {
38 | Schema::dropIfExists('letters');
39 | }
40 | };
41 |
--------------------------------------------------------------------------------
/database/seeders/WindSeeder.php:
--------------------------------------------------------------------------------
1 | getModel('Department')::factory()
14 | ->has(
15 | WindPlugin::get()->getModel('Letter')::factory()
16 | ->count(5)
17 | ->state(function (array $attributes, Department $department) {
18 | return [
19 | 'department_id' => $department->id,
20 | ];
21 | })
22 | )->count(3)->create();
23 | }
24 | }
25 |
--------------------------------------------------------------------------------
/docs/_index.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: v3
3 | slogan: contact form, with ready to use a frontend scaffolding to get you up and running easily.
4 | githubUrl: https://github.com/lara-zeus/wind
5 | branch: main
6 | icon: ri-windy-line
7 | ---
8 |
--------------------------------------------------------------------------------
/docs/changelog.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Changelog
3 | weight: 100
4 | ---
5 |
6 | All changes to `Wind` are documented on GitHub [changelog](https://github.com/lara-zeus/wind/blob/main/CHANGELOG.md)
7 |
--------------------------------------------------------------------------------
/docs/configuration.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Configuration
3 | weight: 3
4 | ---
5 |
6 | ## Configuration
7 |
8 | to configure the plugin Wind, you can pass the configuration to the plugin in `adminPanelProvider`
9 |
10 | these all the available configuration, and their defaults values
11 |
12 | ```php
13 | WindPlugin::make()
14 | ->windPrefix('contact-us')
15 | ->windMiddleware(['web'])
16 | ->defaultDepartmentId(1)
17 | ->defaultStatus('NEW')
18 | ->departmentResource()
19 | ->windModels([
20 | 'Department' => \LaraZeus\Wind\Models\Department::class,
21 | 'Letter' => \LaraZeus\Wind\Models\Letter::class,
22 | ])
23 | ->uploadDisk('public')
24 | ->uploadDirectory('logos')
25 | ->navigationGroupLabel('Wind'),
26 | ```
27 |
--------------------------------------------------------------------------------
/docs/customization.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Customization
3 | weight: 6
4 | ---
5 |
6 | to customize the layout, you can change the default layout in the `zeus.php` config file
7 |
8 | ```php
9 | 'layout' => 'components.app',
10 | ```
11 |
12 | ## Publishing the default layout
13 |
14 | or if you don't have a layout yet, you can publish the default one:
15 |
16 | ```bash
17 | php artisan vendor:publish --tag=zeus-views
18 | ```
19 |
20 | ## Publishing the default views
21 |
22 | to customize the default views for wind:
23 |
24 | ```bash
25 | php artisan vendor:publish --tag=zeus-wind-views
26 | ```
27 |
28 | ## Publishing Translations
29 |
30 | to customize the translations:
31 |
32 | ```bash
33 | php artisan vendor:publish --tag=zeus-wind-translations
34 | ```
35 |
36 | ## themes
37 | soon
38 |
--------------------------------------------------------------------------------
/docs/events.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Events
3 | weight: 5
4 | ---
5 |
6 | ## Available Events
7 |
8 | wind will fire these events:
9 | - `LaraZeus\Wind\Events\LetterSent`
10 | when a new letter sent from the website
11 | - `LaraZeus\Wind\Events\ReplySent`
12 | when you send a replay from the admin panel
13 | - `LaraZeus\Wind\Events\NewLetterSent`
14 | when you send a new letter from the admin panel
15 |
16 | ## Register a Listener:
17 |
18 | * first create your listener:
19 | *
20 | ```bash
21 | php artisan make:listener SendWindNotification --event=LetterSent
22 | ```
23 |
24 | * second register the listener in your `EventServiceProvider`
25 |
26 | ```php
27 | protected $listen = [
28 | //...
29 | LetterSent::class => [
30 | SendWindNotification::class,
31 | ],
32 | ];
33 | ```
34 |
35 | * finally, you can receive the letter object in the `handle` method, and do what ever you want.
36 | for example:
37 |
38 | ```php
39 | Mail::to(User::first())->send(new \App\Mail\Contact(
40 | $event->letter->name, $event->letter->email, $event->letter->message
41 | ));
42 | ```
43 |
--------------------------------------------------------------------------------
/docs/filament.md:
--------------------------------------------------------------------------------
1 | # Zeus Wind
2 |
3 | Wind contact form for your website with easy to use dashboard, works as a plugin for Filament Admin Panel make it easier to customize it and match your branding.
4 |
5 | ## Features
6 |
7 | - 🔥 optionally you can add categories to the contact form like 'sales','dev','report bug' etc.
8 | - 🔥 you can add logos for all categories.
9 | - 🔥 direct URL to contact on specific category.
10 | - 🔥 Frontend scaffolding, highly customizable.
11 |
12 | ## Screenshots
13 |
14 | * **Contact form:** simple contact form allow your users to contact you
15 |
16 | 
17 | 
18 | 
19 |
20 | * **Departments:** optionally you can create departments to make it easy to manage the letters
21 |
22 | 
23 | 
24 |
25 | ## More Details
26 | **✨ to learn more about Wind the form builder, please visit:**
27 |
28 | - [Docs](https://larazeus.com/docs/wind)
29 | - [Github](https://github.com/lara-zeus/wind)
30 | - [Demo](https://demo.larazeus.com)
31 |
--------------------------------------------------------------------------------
/docs/installation.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Installation
3 | weight: 2
4 | ---
5 |
6 | ## Composer
7 |
8 | You can install the package via composer:
9 |
10 | ```bash
11 | composer require lara-zeus/wind
12 | ```
13 |
14 | ## publish
15 | for your convenient, we create a one command to publish them all:
16 |
17 | ```bash
18 | php artisan wind:publish
19 | ```
20 |
21 | you can pass `--force` option to force publishing all the files, helps if you're updating the package
22 |
23 | ## Migrations
24 | to just publish the migrations files
25 |
26 | ```bash
27 | php artisan vendor:publish --tag=zeus-wind-migrations
28 | ```
29 |
30 | ## Seeder and Factories
31 |
32 | optionally, if you want to seed the database, publish the seeder and factories with:
33 |
34 | ```bash
35 | php artisan vendor:publish --tag=zeus-wind-seeder
36 | php artisan vendor:publish --tag=zeus-wind-factories
37 | ```
38 |
39 | ## Assets
40 |
41 | to publish the assets files for the frontend:
42 |
43 | ```bash
44 | php artisan vendor:publish --tag=zeus-assets
45 | ```
46 |
47 | ## Run Migration
48 |
49 | finally, run the migration:
50 |
51 | ```bash
52 | php artisan migrate
53 | ```
54 |
--------------------------------------------------------------------------------
/docs/introduction.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Introduction
3 | weight: 1
4 | ---
5 |
6 | ## Introduction
7 |
8 | Lara-zeus Wind, is a package provides a simple contact form manger, with the abilety to store the messages in the database, and you can reply to them from the dashboard.
9 |
10 | **[Demo](https://wind.larazeus.com) · [Source Code](https://github.com/lara-zeus/wind) · [Discord](https://discord.com/channels/883083792112300104/1282763077611421829)**
11 |
12 | ## features:
13 |
14 | 🔥 built with [TALL stack](https://tallstack.dev/)
15 | 🔥 using [filament](https://filamentadmin.com) as an admin panel
16 | 🔥 optionally you can add departments to the contact form like 'sales','dev','report bug' etc.
17 | 🔥 you can add logos for all departments.
18 | 🔥 direct URL to contact on specific department.
19 |
20 | ## Support
21 |
22 | available support channels:
23 | * Join our channel on [Discord](https://discord.com/channels/883083792112300104/1282763077611421829)
24 | * open an issue on [GitHub](https://github.com/lara-zeus/wind/issues)
25 | * email us using the [contact center](https://larazeus.com/contact-us)
26 |
--------------------------------------------------------------------------------
/docs/thems.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Theming
3 | weight: 20
4 | ---
5 |
6 | ## Tailwind config
7 |
8 | ### for filament
9 | We only have small classes used in `LetterResource`, add to your tailwind config `content`
10 |
11 | ```
12 | './vendor/lara-zeus/wind/src/Filament/Resources/LetterResource.php',
13 | ```
14 |
15 | ### For the frontend
16 | If you have a custom theme you should add the blade files:
17 |
18 | ```
19 | './vendor/lara-zeus/wind/resources/views/themes/**/*.blade.php',
20 | ```
21 |
--------------------------------------------------------------------------------
/docs/update.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Updating Wind
3 | weight: 99
4 | ---
5 |
6 | ## Composer
7 |
8 | to update the package first run:
9 |
10 | ```bash
11 | composer update
12 | ```
13 |
14 | ## Publishing the files
15 |
16 | then run the same command to publish any new files
17 |
18 | ```bash
19 | php artisan wind:publish
20 | ```
21 |
22 | > updating to wind V2 may introduce some braking changes if you already published the views and the configuration file.
23 | we recommend running the `publish` command with the flag: `--force` and check your changes.
24 |
25 | ```bash
26 | php artisan wind:publish --force
27 | ```
28 |
--------------------------------------------------------------------------------
/docs/usage.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Usage
3 | weight: 4
4 | ---
5 |
6 | ## Usage
7 | after you finished installing `wind` all you have to do is visit the url `/admin` to manage the Letters,
8 | and `/wind` to access the contact form.
9 |
10 | check the configuration section for more details
11 |
12 | if you don't have a user, or it's a fresh installation of laravel, you can use the command to create a new user
13 | ```bash
14 | php artisan make:filament-user
15 | ```
16 |
--------------------------------------------------------------------------------
/phpstan-baseline.neon:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/lara-zeus/wind/0269ae99eca2f0f7297504787272ee61057e9d67/phpstan-baseline.neon
--------------------------------------------------------------------------------
/phpstan.neon.dist:
--------------------------------------------------------------------------------
1 | includes:
2 | - phpstan-baseline.neon
3 |
4 | parameters:
5 | level: 6
6 | paths:
7 | - src
8 | - database
9 |
10 | checkOctaneCompatibility: true
11 | checkModelProperties: true
12 |
13 | ignoreErrors:
14 | -
15 | identifier: missingType.iterableValue
16 | -
17 | identifier: missingType.generics
--------------------------------------------------------------------------------
/phpunit.xml.dist:
--------------------------------------------------------------------------------
1 |
2 | {{ $message }}
@enderror 19 |