arpite/arpite

An open-source Laravel library for building high-quality, accessible applications and administration dashboards

dev-master 2024-04-01 13:34 UTC

This package is auto-updated.

Last update: 2024-05-01 13:42:38 UTC


README

Arpite hero image

Arpite

An open-source Laravel library for building high-quality, accessible applications and administration dashboards. Built using Inertia.js, React, TailwindCSS, and HeadlessUI.

Getting Started

⚠️ Arpite is currently in early development and APIs are likely to change quite often. Use in production on your own risk!

  1. Install the packages from Composer and NPM
composer require arpite/arpite
yarn add @arpite/arpite
  1. Render Arpite in resources/js/app.js file
import { Arpite } from "@arpite/arpite";
import "@arpite/arpite/resources/dist/arpite.css";

Arpite.render();
  1. Build assets
yarn build
  1. Add to AppServiceProvider boot() method
Inertia::share([
	"baseUrl" => fn() => URL::to("/"),
	"applicationName" => fn() => env("APP_NAME"),
	"notification" => fn() => Notification::getAndClear(),
	"resetFormIdentifier" => fn() => Session::get("resetFormIdentifier"),
	"csrfToken" => fn() => csrf_token(),
	"balance" => null,
]);
  1. Add HandleArpiteRequests middleware to web group inside app/Http/Kernel.php file
'web' => [
    \Arpite\Core\Middlewares\HandleArpiteRequests::class
]