enjin/platform-ui

A package for adding a user interface to the Enjin Platform.

v1.6.5 2024-04-26 10:16 UTC

Requires

• php: ^8.1|^8.2
• spatie/laravel-csp: ^2.8
• spatie/laravel-package-tools: ^1.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.0
• orchestra/testbench: ^8.0

LGPL-3.0-only

• Enjin

• ui
• laravel
• platform
• user interface
• enjin
• enjin platform
• enjin platform package
• enjin platform ui
• enjin platform interface
• enjin platform user interface

README

This package is an extension of platform-core for adding a user interface.

Installation

Laravel Installation

To install the plugin within Laravel, run the following command:

composer require enjin/platform-ui

Next, run the following command to install the plugin:

php artisan platform-ui:install

During the installation process, you will be prompted to enter the route, hostname, and authorization token.

Static Hosting

If you want to host the frontend interface statically, follow these steps:

1. Clone the repository to your local machine
2. Run npm install to install the dependencies
3. Run npm run prod to build the project
4. Copy the dist folder to your server

Usage

Laravel Usage

After installing the plugin within Laravel, you can access the frontend interface by visiting the URL you specified during installation.

Static Hosting Usage

If you are hosting the frontend interface statically, you can access it by visiting the URL where you copied the build folder.

License

The LGPL 3.0 License. Please see License File for more information.