Skip to content
Orbix Laravel · Tailwind CSS v1.0.5

Updating Orbix

Each release of Orbix is listed in Changelog with the files it touches. Download the new version from your account downloads page at the store or marketplace where you purchased Orbix.

  1. Keep your project under version control (Git or similar) before changing anything.
  2. Extract the new version into a separate folder; never overwrite your project with it.
  3. Compare the new version with the version you started from (a folder diff tool such as WinMerge, Meld or Beyond Compare, or git diff --no-index old/ new/). Since your own code lives in your views, routes, configuration and CSS files, most updates come down to a few files.
  4. Copy what you need:
    • packages/foundry-ui/ (the design system) can usually be replaced as a whole.
    • resources/css/orbix/, resources/js/core/ and resources/views/components/ hold the template code: merge the changes into your copies if you edited them.
    • New pages: copy the views, their routes in config/orbix-pages.php and their keys in lang/*.json.
  5. Run composer install, npm install, npm run build and php artisan test.

Updating Laravel and the dependencies

Orbix uses standard Laravel: follow the official upgrade guide for major versions. Minor updates of the PHP and npm dependencies are safe with composer update and npm update, followed by npm run build and the tests.

Keeping customizations easy to update

  • Add new styles in your own CSS files instead of editing the Orbix ones.
  • Set the theme defaults in initTheme() (see Theming) instead of editing tokens.
  • Add translation keys with your own prefix (app.*) so new Orbix keys never collide with yours.