# Moox Project
Welcome to the Moox Project. This is a Monorepo and installable Laravel App to develop our Filament Plugins aka Laravel Packages. We are in an early stage of development but there are already some plugins you might consider useful:
## Packages
- [Moox Builder](packages/builder/README.md), our Skeleton Package to create new Filament Plugins
- [Moox Core](packages/core/README.md), required by all of our packages, ships common things
- [Moox Jobs](packages/jobs/README.md), manage Job Queues, Failed Jobs and Batches in Filament
Some are in productive use but not yet documented:
- [Moox Expiry](packages/expiry/README.md), define and automate the expiry of your records
- [Moox User Device](packages/user-device/README.md), manage your users' devices and decide how to handle unknown
- [Moox User Session](packages/session/README.md), manage your users' session (also in context of devices)
All other packages are under hard development:
- [Moox Audit](packages/audit/README.md), logging and auditing, security-related and model-related
- [Moox Flags](packages/flags/README.md), Flags contains Blade Icons for countries, languages and more
- [Moox Locate](packages/locate/README.md), countries, languages, currencies, country prefixes, timezones
- [Moox Login Link](packages/login-link/README.md), send Login-Links (aka magic links) to your users
- [Moox Page](packages/page/README.md), content management, currently abandoned as we use Press
- [Moox Passkey](packages/passkey/README.md), give users the ability to use Passkeys (Webauthn)
- [Moox Permission](packages/permission/README.md), manage roles and permissions using Spatie Permission
- [Moox Press](packages/press/README.md), use WordPress without using WordPress, in Filament
- [Moox Redis Model](packages/redis-model/README.md), use Redis as plug-in replacement for your models
- [Moox Security](packages/security/README.md), manage your password security and other security features
- [Moox Sync](packages/sync/README.md), sync records from server to server, add logic and transformers
- [Moox Trainings](packages/trainings/README.md), automate trainings, invitations and self-validation
- [Moox User](packages/user/README.md), manage your users in Filament and give users access to their profile
And there is some other stuff NOT in this repo:
- [Moox DevOps](https://github.com/mooxphp/moox-server/tree/main/packages/devops), Manage your Forge-Servers, Sites and Deployments
- [Moox Backup Server UI](https://github.com/mooxphp/moox-server/tree/main/packages/backup-server-ui), Filament UI for Spatie Laravel Backup Server
- [Moox VS Code Extensions](https://github.com/mooxphp/vscode), our VS code extension pack for Filament devs
## Installation
The Laravel dev app in the root-folder of the Moox Monorepo is made for instant development with Laravel Herd, Laravel Valet, Laravel Sail or Laragon.
```bash
# Create a .env file and adjust to your needs
cp .env.example .env
# Don't forget to create the database according .env
# Install via Composer
composer install
# Migrate and seed
php artisan migrate:fresh --seed
# Use Vite (for Laravel Sail on Windows: do it in Ubuntu, not inside the Sail container)
npm install
npm run dev
```
Optional things:
```bash
# You can create a user then
php artisan make:filament-user
# You can use the custom composer.json
cp _custom/composer.json-example _custom/composer.json
# Run Sail (alternatively start Herd,Laragon or Valet)
./vendor/bin/sail up
# Rebuild the sail config if needed
./vendor/bin/sail down --rmi all -v
php artisan sail:install
# Remove broken symlinks if needed
# switching from Laragon to Sail for example
rm -Rf vendor/mooxphp
```
The Moox Admin is now available at /moox, e. g. https://moox.test/moox
## Moox Press
To install Moox Press, you need a WordPress running in /public/wp (or another subdirectory, configured in .env).
### Install a fresh WordPress
To install a fresh WordPress, we provide an artisan command, shipped with the Moox Press package:
```bash
php artisan mooxpress:wpinstall
```
The command needs some optimization and runs only "half" on Windows.
## Custom packages
Our Monorepo is prepared to be a double agent:
- Develop a private or public project
- while contributing to the Moox project
This is done by supporting custom packages in the development app of our Monorepo. Sounds interesting? Read on [\_custom/README.md](_custom/README.md).
## Development
- Do `npm run build` before committing because automated tests on GitHub needs a working vite-manifest
- Do `php artisan migrate --database=sqlite` to reflect changes to the test-database
- Use https://marketplace.visualstudio.com/items?itemName=adrolli.tallui-laravel-livewire-tailwind with VS Code
- Use https://github.com/mooxphp/builder to create your own packages
- Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Branching
- `main` is the current stable version, branch-protected, auto-commits to all packages, deployed to li
- `feature/...` please prefix all feature-branches, create your pull requests directly to main
Use issue-based branches, prefix them with feature/ (e.g. feature/38-welcome-view) for automated tests and code analysis.
## Commits
Your commit messages will be merged into Changelog.md, means they become part of the documentation. Please make sure, you
- start with one of these types
- Bump = minor version change, major if used as Bump!
- Clean = deleting old stuff or unused code
- Deps = changing dependencies
- Devops = GH and automation
- Docs = documentation
- Feat = feature
- Fix = bugfix
- Lang = translation
- Tests = writing tests
- Wip = work in progress
- for breaking changes add "!" to any type to craft a major release
- followed by the shortname of the package, in []
- All - multiple or all packages
- Repo - Monorepo things
- Core
- Builder
- Jobs
- ...
- reference an issue, linked by issue number, e. g. #138
- prepare auto-closing the issue by using "Close #138"
### Valid examples
- `Wip[Core]: Feature register assets w-i-p #123`
- `Fix[All]: Update all packages Close #321`
- `Feat[Monorepo]: Update dev app Close #22`
- `Bump![ChartComponents]: Major Updates`
- `Feat![PackageBuilder]: This will become a major release #23`
Read more about [conventional commits](https://www.conventionalcommits.org/).
## Pull requests
Create a PR to `main`. Use conventional commits like explained above.
### Semver
We use semantic versioning, written like 1.2.3 for
1. Major releases
2. Minor releases
3. Bugfix releases
Visit [Semver.org](https://semver.org/) for more information.
## Releases
Currently done manually, an automatic release feature is on the way.
## Testing
We test Moox using:
- Monorepo
- [Larastan](https://github.com/nunomaduro/larastan), [PHPStan](https://phpstan.org/) Level 5
- [Laravel Pint](https://laravel.com/docs/pint), PHP CS Fixer
- [Codacy](https://app.codacy.com/gh/mooxphp/moox/) and [Code climate](https://codeclimate.com/github/mooxphp/moox)
- Packages
- [Larastan](https://github.com/nunomaduro/larastan), [PHPStan](https://phpstan.org/) Level 5
- [Laravel Pint](https://laravel.com/docs/pint), PHP CS Fixer
- [Pest](https://pestphp.com/)
Please make sure you use the same tools in VS Code (our [VS Code Extension Pack](https://marketplace.visualstudio.com/items?itemName=adrolli.tallui-laravel-livewire-tailwind) covers this) or do the checks manually before committing to the dev-branch:
- PHPStan: `composer analyse ` or `./vendor/bin/phpstan analyse`, for packages `../../vendor/bin/phpstan analyse`
- Pest: `composer test ` or `./vendor/bin/pest`, for packages `../../vendor/bin/pest`
- Coverage: `composer test-coverage ` or `./vendor/bin/pest --coverage`, for packages `../../vendor/bin/pest --coverage`
- Pint: `composer format ` or `./vendor/bin/pint`, for packages `../../vendor/bin/pint`
## Admin Navigation
Titles and sorting in the AdminPanel can be adjusted in the packages configs, but this is the default sorting that keeps everything in place:
```
- Dashboard
- Main - 1000
- Expiry - 1100
- Notifications - 1800
- Content - 2000
- Posts - 2100
- Pages - 2200
- Media - 2300
- Categories - 2400
- Tags - 2500
- Comments - 2600
- Custom - 3000
- ...
- Meta - 4000
- Wp Meta...
- Custom - 5000
- ...
- Users - 6000
- App users - 6010 (Moox Users, Moox Press Users 6015)
- Site users - 6020
- Customers - 6030
- Registrations - 6100
- Roles - 6200
- Permissions - 6201
- Devices - 6300
- Sessions - 6400
- Login-Links - 6500
- Password-Tokens - 6600
- Passkeys - 6700
- System - 7000
- Audit - 7500
- Options (Press) - 7900
- Jobs - 8000
- Job manager - 8001
- ...
- Tools - 9000
- Sync - 9500
- Backup - 9800
- Builder - 9990
```
## Contributors
Moox is made by these nice people, and bots ...
This table is generated by [All Contributors Bot](https://allcontributors.org/). To add contributors use the following command in any comment of an issue or PR:
`@all-contributors please add @github-user for code`
We typically use "code" and "translation", but there are other possible types listed on [AllContributers.org](https://allcontributors.org/docs/en/emoji-key). Please do only one request at a time, as we'll run into merge conflicts if you try to add multiple contributors without merging the PR in between.
## Contribute
We welcome every contribution! It would be awesome, if you:
- Create an Issue in the Repo that fits best and add information about the problem or idea. We'll reply within a couple of days.
- Create a Pull Request in this Monorepo. Please do not PR to our read-only repos, they are not prepared for code changes. Only the monorepo has quality gates and automated tests.
- Translate Moox using [Weblate](https://hosted.weblate.org/engage/moox/).
- Tell other people about Moox or link to us.
- Consider a [donation or sponsorship](https://github.com/sponsors/mooxphp).
## Translation
Moox is translated with Weblate. Of course you can also directly edit the translation files in the packages, but using a full-featured translation platform like Weblate might be more convenient.
## License
Moox is free Open-Source software licensed under the [MIT License](LICENSE.md).
Some of the projects we depend on are released under a different license. We do our best to make sure that these licenses allow private as well as commercial use and do not impose any restrictions.
If you notice any problem with Moox licensing or any dependency, please mail us at dev@moox.org.
## Security
As mentioned above, we use automated code checks and security audits to ensure that our code is free of security vulnerabilities.
Read our [Security Policy](SECURITY.md) to learn more about security or report a potential vulnerability. Please DO NOT use the issue tracker for reporting security-related issues.
![renovate[bot]](https://avatars.githubusercontent.com/in/2740?v=4?s=100)
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4?s=100)
![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4?s=100)
