https://github.com/kristi11/ww-filament
A TALL stack foundation for niche marketplaces and small businesses.
https://github.com/kristi11/ww-filament
alpinejs appointments-manager business customization dashboard e-commerce filamentphp laravel livewire3 otp roles-permission-management stripe stripe-api stripe-payments tailwindcss tall-stack
Last synced: 3 months ago
JSON representation
A TALL stack foundation for niche marketplaces and small businesses.
- Host: GitHub
- URL: https://github.com/kristi11/ww-filament
- Owner: kristi11
- Created: 2024-05-23T02:59:58.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-08T16:38:17.000Z (3 months ago)
- Last Synced: 2025-04-08T17:35:11.932Z (3 months ago)
- Topics: alpinejs, appointments-manager, business, customization, dashboard, e-commerce, filamentphp, laravel, livewire3, otp, roles-permission-management, stripe, stripe-api, stripe-payments, tailwindcss, tall-stack
- Language: PHP
- Homepage: https://www.wittyworkflow.com
- Size: 28 MB
- Stars: 22
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- Security: SECURITY.md
Awesome Lists containing this project
README
Witty workflow
A platform for managing your business
Interactive Demo
·
Report Bug
·
Request Feature
> # This app is in active development
## **THIS REPOSITORY SHOULD BE USED ON A BRAND-NEW PROJECT**
Table of Contents
-
About The Project
-
Getting Started
- Command list
-
Configuration
- Shop
- Usage
- Roadmap
- What's next
- Contributing
- License
- Contact
- Acknowledgments
-
Known issues
## About The Project
##### WittyWorkflow is a TALL stack (Tailwind CSS, Alpine.js, Laravel, Livewire) foundation designed for building niche marketplaces and small business management tools. Whether you’re crafting an e-commerce shop, managing appointments, or creating custom workflows, this modular platform—powered by Filament PHP—offers a robust starting point. It’s built to be forked, extended, and deployed fast, with features like role-based dashboards, Stripe payments, and customizable UI out of the box.
##### Originally a demo app, WittyWorkflow has evolved into a versatile base for real-world projects. A prime example? It’s being adapted into the Artisanal Food Production Manager—a marketplace example connecting artisanal producers to customers, complete with product listings, orders, and secure payments. Developers can use it as-is for small business needs or tailor it to specialized industries like handmade goods, local services, or boutique retail.
### Interactive Demo
**Watch a guided tour of Witty Workflow's key features and intuitive interface.**
### Key Features
> * **Dynamic Hero:** Capture attention with a visually stunning, admin-customizable hero section—fully editable via Filament for a seamless experience.
> * **Role-Based Access:** Leverage Filament PHP for flexible, role-based dashboards—admins control all, team members and customers (e.g., producers/retailers) get tailored views, powered by Shield.
> * **SPA-Like Navigation:** Enjoy smooth transitions with Livewire’s `wire:navigate`—enhances UX across panels and public pages.
> * **Customizable Contact & Footer:** Boost engagement with a public email form and admin-editable footer for terms, help, or business details.
> * **E-commerce Module:** A TALL stack shop with Stripe integration, product management, and admin control—perfect for niches like artisanal food.
> * **Appointment Management:** Schedule and manage appointments with email notifications—optional for service-based apps.
> * **Security Suite:** Protect accounts with 2-Factor Authentication (2FA) and One-Time Passwords (OTP)—toggleable for your needs.
> * **Theme Customization:** Tailor the app’s look with admin-controlled themes and section visibility—swap styles without code.
> * **Application Health:** Monitor performance and server status with Spatie Laravel Health—actionable insights from the dashboard.
> * **Business Settings:** Manage announcements, visibility, and niche-specific data—adaptable for any small business or marketplace.
> * **Developer Tools:** Demo seeds, and modular structure—fork and extend with ease.
## Built With
This section lists all major frameworks/libraries used to bootstrap this project.
* Laravel 10.x
* Filament 3.x
* PHP 8.1
* 
* 
* 
* 
* 
* 
### Use Cases
#### WittyWorkflow powers niche apps—here’s how:
- **Artisanal Food Marketplace**: Producers list products, customers order, payments via Stripe.
- **Local Service Hub**: Book appointments for craftspeople, manage team schedules, customize the public page.
- **Boutique E-commerce**: Run a standalone shop with themed UI, secure logins, and order insights.
- **Creative Freelancer Platform**: Artists and designers showcase portfolios, clients request quotes and track project milestones.
- **Pop-up Event Manager**: Coordinate vendors, sell tickets, and create dynamic event pages with real-time updates.
- **Fitness Studio Management**: Schedule classes, process memberships, and enable instructor/client communication.
Fork it, tweak it—build your vision fast.
### Getting Started
Get WittyWorkflow running in minutes—perfect for prototyping or building your next niche app.
#### Quickstart
1. Clone the repo:
```
git clone https://github.com/kristi11/ww-filament.git
```
2. Cd into project
```
cd ww-filament
```
2. Install NPM dependencies
```
npm install
```
3. Install the composer dependencies.
```
composer install
```
4. Create a copy of your .env file.
```
cp .env.example .env
```
5. Generate an app encryption key.
```
php artisan key:generate
```
if using laravel [forge](https://forge.laravel.com/) there's no need to generate key since when creating the
server [forge](https://forge.laravel.com/) will take care of the key generation.
6. Create an empty database for your application. I personally like using [TablePlus](https://tableplus.com/), but you
can
use whatever you like.
7. In the `.env` file, add database information to allow Laravel to connect to the database. The default database name
is `ww_filament`. If you are using a different name, you'll need to edit the `DB_DATABASE` variable in the `.env`
file with your database name.
8. Migrate and seed the database.
```
php artisan migrate:fresh --seed
```
9. WittyWorkflow uses [Shield](https://filamentphp.com/plugins/bezhansalleh-shield) plugin
to provide proper user roles. We need to set up the plugin and generate the permissions for that package
```
php artisan shield:setup --fresh
php artisan shield:generate --all --panel=admin
```
and define the super admin of the system
```
php artisan shield:super-admin --user="1"
```
`--user=1` is the `id` of the user that will be the `super admin`. You can change it to whatever user you want to be
the `super admin`.
10. Link the storage folder.
```
php artisan storage:link
```
11. Run the application.
```
php artisan serve
```
12. Visit your application in the browser.
```
http://localhost:8000
```
### Command list
```
git clone https://github.com/kristi11/ww-filament.git .
npm install
composer install
cp .env.example .env
php artisan key:generate
php artisan migrate:fresh --seed
php artisan shield:setup --fresh
php artisan shield:generate --all --panel=admin
php artisan shield:super-admin --user="1"
php artisan storage:link
```
Don't forget to run `npm run dev` and `php artisan serve`
after the above commands are ran.
> [!NOTE]
>
> Don't forget to update your Mail settings to reflect your production server's needs
I use [Mailtrap](https://mailtrap.io/) for local email testing. You can use whatever you like. If you want to
use [Mailtrap](https://mailtrap.io/),
create an account and add the credentials to the `.env` file. If you are using [forge](https://forge.laravel.com/) you
can add the credentials to the server environment variables.
If you decide to use [Mailtrap](https://mailtrap.io/), you can use the following credentials:
```
MAIL_MAILER=smtp
MAIL_HOST=smtp.mailtrap.io
MAIL_PORT=2525
MAIL_USERNAME=your_username
MAIL_PASSWORD=your_password
MAIL_ENCRYPTION=tls
MAIL_FROM_ADDRESS=your_email
MAIL_FROM_NAME="${APP_NAME}"
```
If you are using [forge](https://forge.laravel.com/) you can add the credentials to the server environment variables.
## Shop
Add the Stripe credentials:
```
STRIPE_KEY=your-stripe-key
STRIPE_SECRET=your-stripe-secret
STRIPE_WEBHOOK_SECRET=your-stripe-webhook-secret
```
In your local server (for testing purposes only) use [stripe-cli](https://docs.stripe.com/stripe-cli) and run `stripe login` to log in into stripe and then `stripe listen --forward-to {your url here}/stripe/webhook --format JSON` to listen to Stripe's webhook.
After running the `stripe listen` command you will be provided with the `STRIPE_WEBHOOK_SECRET` that you need to paste into your `.env` file for the webhook to function properly. Installation instructions for your local development environment will be in the stripe-cli link above
To make test purchases in your local environment you can enter card nr. `4242 4242 4242 4242`. Any 4 numbers for expiration date for example `03/11` and any 3 numbers for CVC code for example `111`. This is stripe's testing card numbers
#### To enter Stripe's live mode you need to complete your business profile in [Stripe's dashboard](https://dashboard.stripe.com/test/dashboard) and change the API keys from _test_ to _live API keys_. Also after running `php artian cashier:webhook` in your production server you need to go to the [webhooks page](https://dashboard.stripe.com/webhooks) click on the newly created webhook and copy the `Signin secret` to your `STRIPE_WEBHOOK_SECRET` in your `.env` file. Also, I noticed that the `php artian cashier:webhook` doesn't generate the `checkout.session.completed` so you will have to do that manually in order for the purchase to go through. To do that click on the newly created webhook and as of `11/13/2024` you can go to the `...` button on the right side of the page, choose `update details` and on the `events to send` click `select events...` and enter `checkout.session.completed`. This way stripe will start listening for the event and proceed the payment.
# Your application is now ready for use. Enjoy! To install it in production follow your servers specific needs.
## Configuration
### **Disabled features:**
> [!IMPORTANT]
>
> ##### Switch the `canEdit()` function in `CRUDSettingsResource.php` to `true` ose `false` to enable or disable choosing whether the admin should be able to edit content or not.
### **Side note:**
#### If the `canCreate()`, `canEdit()` or `canDelete()` functions return anything other than a `true` or `false` value is best not to mess with that value because that value is supposed to be that way.
WittyWorkflow uses [filament-breezy](https://filamentphp.com/plugins/jeffgreco-breezy) to
manage user profiles. Change the following value to `shouldRegisterUserMenu: true/false` depending on your app's needs,
to `enable/disable` profile editing on `AdminPanelProvider.php` and `TeamPanelProvider.php` for the `Admin` and `Team member`
roles
```
->myProfile(
shouldRegisterUserMenu: false, // Sets the 'account' link in the panel User Menu (default = false)
shouldRegisterNavigation: false, // Adds a main navigation item for the My Profile page (default = false)
navigationGroup: 'Settings', // Sets the navigation group for the My Profile page (default = null)
hasAvatars: false, // Enables the avatar upload form component (default = false)
slug: 'profile' // Sets the slug for the profile page (default = 'my-profile')
)
->enableTwoFactorAuthentication(
force: false, // force the user to enable 2FA before they can use the application (default = false)
)
```
### Role configuration
WittyWorkflow used the [Shield](https://filamentphp.com/plugins/bezhansalleh-shield)
package to manage roles as stated above. In order to give permissions to manage appointments go on the `Roles` section of the dashboard, inside the `Settings` sidebar menu group and for both `team_user` and `panel_user` choose `select all` on
the `Appointment` model permissions and to give the `panel_user` view permissions on the gallery choose `view`
and `view any` under the `Gallery` model permissions. Also give the `panel_user` all permissions on the `Order` model permissions.
### Role explanation
#### In order to use the Team role you need to create the role from the admin panel and the name of the role should be 'team_user' as it doesn't exist by default and then assign that role to a desired user. Multiple roles can be assigned to a user
* `super_admin` = The super admin of the system
* `team_user` = The team members of the system assigned by the Super Admin
* `panel_user` = The panel for the customers
### Panel switching
> [!NOTE]
>
> In order to properly switch user panels for different roles the admin of the system must be assigned all the available roles (`super_admin`, `team_user` and `panel_user`) in the user resource. That way the admin will not be prompted with a `403` code when trying to access a panel that he doesn't have access to.
### Adding variants
**There are quite a few steps you need to take to add/edit/delete variants, and I'll walk you through all of them:**
* Create migration to `add/edit/delete` database variants.
* Update the `ProductVariant.php` factory if needed. As of now only the `size` and `color` variants are assigned on the initial database seed just to keep things simple.
* Add the`Enum` for the newly created variant in `App/Enums`. To keep things simple, the enum can be named the same name as the database column, but you can name it whatever you want.
* Update the `getForm()` function in `ProductVariant.php` model, add/edit/delete the desired variants.
* Update the `$table` function in `ProductVariantResource.php`, add/edit/delete the desired variants.
* Update the `$table` function in `VariationsRelationManager.php`, add/edit/delete the desired variants.
* Add/Update/Delete the newly created Enum name inside `config/enums.php`.
* Update '$casts' on the `ProductVariant.php` model
**If the above steps have been implemented, your newly created variant is ready for use throughout the app.**
> [!NOTE]
>
> **The App comes preloaded with some general variants and some tech variants. You should add the variant types that fit the type of store you're building.**
> [!Important]
>
> OTP is now available for an extra added layer of security. To enable OTP just go to your desired panels and uncomment `//FilamentOtpLoginPlugin::make(),`. The available panels are `AdminPanelProvider.php`, `CustomerPanelProvider.php` and `TeamPanelProvider.php`. If you're going to enable OTP is advisable to enable it on all panels but that depends on your app's needs.
## Usage
To access the `super-admin dashboard, go to the [Super-admin dashboard](https://wittyworkflow.com/admin/login) and enter the following
credentials::
```
Email: [email protected]
Password: password
```
To access the `team dashboard` go to the [Team dashboard](https://wittyworkflow.com/team/login) and enter the following
credentials:
```
Email: [email protected]
Password: password
```
To access the `customer dashboard` go to the [Customer dashboard](https://wittyworkflow.com/dashboard/login) and create
an account
## Roadmap
1. [X] Create separate dashboards for each user role
2. [X] Add Filament [Shield](https://filamentphp.com/plugins/bezhansalleh-shield) for managing user roles and
permissions
3. [X] Create business information resources (appointments, services, users etc. )
4. [X] Add socials resource for referencing business's social profiles
5. [X] Add CRUD functionality to sections of the public page for a more controlled and customizable experience
6. [X] Add Hero animations
7. [X] Add footer resources to give users an easy way to add their policies, FAQ and other business related information
8. [X] Add flash notifications and email notifications for appointment changes
9. [X] Add shop for purchases
11. [X] Improve visuals (**ongoing effort**)
15. [X] Add [Announce](https://filamentphp.com/plugins/rupadana-announce) package to announce different messages to
system users
16. [X] Add [Themes](https://filamentphp.com/plugins/hasnayeen-themes) package to give users more options on system
layout and design
17. [X] Add [Filament Breezy](https://filamentphp.com/plugins/jeffgreco-breezy) for 2-factor authentication and better
profile updating
18. [X] Add [Language-switch](https://filamentphp.com/plugins/bezhansalleh-language-switch) to support different
languages
19. [X] Add [Spatie Laravel Health](https://filamentphp.com/plugins/shuvroroy-spatie-laravel-health) to check how the
app is running.
22. [X] Add One Time Passwords (OTP) for an extra added layer of security
23. [X] Add [Panel switch](https://filamentphp.com/plugins/bezhansalleh-panel-switch) so the administrator switches between the panels for each of the available roles to see what's available for that particular panel and make the necessary changes if needed
24. [X] Add [auto logout](https://filamentphp.com/plugins/niladam-auto-logout) plugin where you can set an auto logout timer to bump up security
### Whats-next
### WittyWorkflow is evolving—here’s what’s next:
- [ ] **Niche Marketplace Features**: Add producer/retailer panels, delivery tracking for projects like artisanal food hubs (Help Wanted).
- [ ] **Enhanced E-commerce**: Stripe Connect payouts, shipping integrations (e.g., USPS API).
- [ ] **Core Polish**: Improve visuals, optimize dashboard data (Ongoing).
- [ ] **Dev Tools**: Add Laravel Reverb for live order tracking, Excel export for orders.
- [ ] **User Experience**: Theme switcher UI, email template builder (Help Wanted).
- [ ] **Analytics**: Basic admin stats (e.g., sales, user growth).
> [!NOTE]
>
> ## Known issues
>
> The following are the known issues that need addressing and I hope that the community will step in and work on them:
>
> * Cart items don't get sent from `session id` to `user_id` if the user was logged out when placing the order but after filling out the cart logs in/registers for an account to continue with the order.
## Workaround
* For now as a workaround only logged-in users can add to cart.
## Contributing
Love open source? Help shape WittyWorkflow:
1. Fork the repo.
2. Create a branch: `git checkout -b feature/your-idea`.
3. Commit changes: `git commit -m "Add cool thing"`.
4. Push: `git push origin feature/your-idea`.
5. Open a PR to `main`.
Check [Issues](https://github.com/kristi11/ww-filament/issues) for tasks (e.g., cart bug)—email [email protected] with questions.
## License
Distributed under the MIT License. See `LICENSE` for more information.
## Contact
## Connect with Me
[
](https://github.com/kristi11)
Project Link: [https://github.com/kristi11/ww-filament/](https://github.com/kristi11/wittyworkflow/)
## Acknowledgments
I've included a few of my favorite links to kick things off!
* [Laravel](https://laravel.com)
* [Filament](https://filamentphp.com/)
* [Livewire](https://livewire.laravel.com)
* [Tailwind CSS](https://tailwindcss.com)
* [README Template](https://github.com/othneildrew/Best-README-Template/)
* [Markdown Badges](https://github.com/Ileriayo/markdown-badges)
* [Choose an Open Source License](https://choosealicense.com)
* [GitHub Pages](https://pages.github.com)