Skip to content

Latest commit

 

History

92 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

foxws.nl

The source of foxws.nl: the homepage and documentation site for the Foxws Laravel packages.

It's shared as a working example of those packages running together in a real application. It's provided as-is, for reading and borrowing from. It isn't a starter kit, and other setups aren't supported.

Stack

Foxws packages in use

Package Where to look
foxws/laravel-docs Pulls each package's docs/ folder from GitHub into the database. Rendered by src/Modules/Marketing (controllers, Http/Props, Support/DocsNavigation.php).
foxws/laravel-podman Local development containers, rendered from containers/stubs
foxws/laravel-ddd The src/Domain, src/Modules, src/Foundation and src/Support layout
foxws/laravel-essentials Application defaults, configured in config/essentials.php
foxws/laravel-pwa Web app manifest and service worker (@pwaHead/@pwaSw in resources/views/app.blade.php)
foxws/laravel-scout-builder Docs search in SearchController

Layout

src/
├── Domain/       Business logic: models, actions, states (users)
├── Modules/      Features served over HTTP; Marketing is the public site
├── Foundation/   Service providers and app-wide middleware
└── Support/      Framework glue: CSP presets, Inertia middleware, response cache profile
resources/js/
├── pages/        Inertia pages (HomePage, ProjectView, DocumentView, ...)
└── components/   Vue components, built on Nuxt UI

Running it locally

You'll need PHP 8.3 or newer, Node 24 with pnpm, PostgreSQL and Valkey (or Redis). Development here runs in Podman containers through laravel-podman, but any setup with those services works.

composer run setup
composer run dev

The site is empty until it has documentation to show. Register a project and sync it:

php artisan docs:projects:add laravel-docs "Laravel Docs" --github=foxws/laravel-docs --sync

--sync registers a latest version tracking main as the default and syncs it right away. Use docs:versions:add to register further versions, such as a release tag, or to change the default with --default.

Tests

php artisan test --compact
composer run lint:check

License

The source code is released under the MIT License. See LICENSE.

The Foxws name, logo and icons, and the site's written content, aren't covered by that license: all rights reserved. If you reuse the code, replace them with your own.

About

Source of foxws.nl, the documentation site for the Foxws Laravel packages. Built with Laravel 13, Octane, Inertia v3, Vue and Nuxt UI.

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages