PHPackages nexopos/core - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Admin Panels](/categories/admin) 4. / 5. nexopos/core ActiveLibrary[Admin Panels](/categories/admin) nexopos/core ============ 0411[1 issues](https://github.com/nexopos/core/issues)[1 PRs](https://github.com/nexopos/core/pulls)JavaScript Since Jan 24Pushed 3w ago2 watchersCompare [ Source](https://github.com/nexopos/core)[ Packagist](https://packagist.org/packages/nexopos/core)[ RSS](/packages/nexopos-core/feed)WikiDiscussions main Synced today READMEChangelogDependenciesVersions (2)Used By (0) NexoPOS Core ============ [](#nexopos-core) This package is a separation of the core features of NexoPOS from the POS related features. This gives all the necessary information to start a lightweight app with proven features: - User Authentication - Roles Management - Module Support - Widget Support - Settings Support Installation ------------ [](#installation) This package is available on Packagist and can be installed as a package on a regular Laravel installation: ``` composer require nexopos/core:dev-main ``` You'll instruct Composer to allow such a project by editing the composer.json file with: ``` "minimum-stability": "dev", "prefer-stable": true ``` ### Filesystem Configuration [](#filesystem-configuration) The package includes a command to writethe filesystem configuration to the filesystem.php. For that, you need to run the command: ``` php artisan ns:install --filesystem ``` ### Publishing Service Provider [](#publishing-service-provider) Before proceeding, we'll publish NexoPOS by using the command "vendor:publish". ``` php artisan vendor:publish ``` Note that you'll be asked to select the provider. Select `Provider: Ns\Providers\ServiceProvider`. Alternatively, you'll update/install assets by running this command: ``` php artisan ns:publish-assets ``` #### Laravel Sanctum [](#laravel-sanctum) As the project relies on Laravel Sanctum, you need to run this command to install (publish) the Laravel Sanctum configuration. Note that the package is already a dependency. ``` php artisan install:api ``` This will publish all the necessary information for Sanctum to work. As NexoPOS Core performs API calls, we need to configure the Sanctum middleware that will ensure all frontend requests are Stateful. This will be performed on the app.php located in the "bootstrap" directory. ``` use Laravel\Sanctum\Http\Middleware\EnsureFrontendRequestsAreStateful; use Ns\Http\Middleware\ApiMiddleware; // ... ->withMiddleware( function( Middleware $middleware ) { $middleware->statefulApi(); $middleware->group( 'api', [ EnsureFrontendRequestsAreStateful::class, ApiMiddleware::class, ]); }) // ... ``` ### Core Routing Configuration [](#core-routing-configuration) Similarily to Laravel Sanctum, NexoPOS Core needs some files to be published. Note that here, some of the existing files will be edited by the package as It needs it to work properly. The impacted files are: - config/filesystems.php - routes/api.php #### Installing Web and API routes [](#installing-web-and-api-routes) ``` php artisan ns:install --routes ``` These commands will perform two things: - It will publish the filesystem required to the filesystems.php - It will update your api.php to trigger an event. #### Installing Scheduling [](#installing-scheduling) to give access to laravel scheduling to the module, we need to enable it by running the following command: ``` php artisan ns:install --scheduling ``` #### Installing Lang [](#installing-lang) ``` php artisan ns:install --language ``` Authentication -------------- [](#authentication) ### Sanctum Configuration [](#sanctum-configuration) NexoPOS Core uses its own implementation of authentication. While it's created on top of laravel, it provides more features. Therefore, it's recommended to change the model provider on the config/auth.php. If you're using Laravel 12, you only need to set it using "AUTH\_MODEL" on the environment file. ``` AUTH_MODEL = Ns\Models\User ``` Define the default authentication route. You'll need to add on the app.php on the bootstrap directory, where unauthenticated users should be redirected. ``` // ... ->withMiddleware(function (Middleware $middleware) { // ... $middleware->redirectGuestsTo( fn() => route( 'ns.login' ) ); // ... }) // ... ``` - Sanctum (publish vendors) Modules ------- [](#modules) ### PSR-4 Autoloading [](#psr-4-autoloading) As we've exported core features of NexoPOS, modules are supported. However, for the module files to be automatically loaded, you need to edit the composer.json file of the Laravel project. On The "autoload" entry, make sure to add to the "psr-4" entry the following: ``` "Modules\\": "modules/" ``` ### Routing Registration [](#routing-registration) Modules come with routes. But by default, Laravel will not load its routes. Therefore, we need to instruct Laravel to load the module route while it's loading the application route. For that, on the app.php file located on the bootstrap folder, we'll add a "using" callback to the method "withRouting". ``` use Ns\Classes\ModuleRouting; use Illuminate\Support\Facades\Route; // ... ->withRouting( // ... // web: __DIR__.'/../routes/web.php', // api: __DIR__.'/../routes/api.php', commands: __DIR__.'/../routes/console.php', health: '/up', using: function() { Route::middleware( 'api' ) ->prefix( 'api' ) ->group( base_path( 'routes/api.php' ) ); Route::middleware( 'web' ) ->group( base_path( 'routes/web.php' ) ); ModuleRouting::register([ 'web', 'api' ]); } ) // ... ``` Note that if you use "using", then any load of the web.php file or api.php file set as a parameter of withRouting, will be ignored. That's the reason why we've imported the api.php and web.php files within the anonymous function. Socket Support -------------- [](#socket-support) We've created a custom approach for working with Sockets on NexoPOS. The idea here is that when the user logs in, we'll create an access token that will be stored on the personnal\_access\_token table and set on the session. ``` public function handle( Validated $event) { $token = $event->user->createToken( 'token', ['*'], now()->addWeek() )->plainTextToken; session()->put( 'token', $token ); } ``` This token is then used to authenticate the socket connection. ### Health Score 24 — LowBetter than 31% of packages Maintenance62 Regular maintenance activity Popularity10 Limited adoption so far Community9 Small or concentrated contributor base Maturity14 Early-stage or recently created project Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Community Maintainers ![](https://www.gravatar.com/avatar/c5c84d5dba91111738af4ee2c62736f660bab2d44e497a1b7c34b347d52e7834?d=identicon)[nexopos](/maintainers/nexopos) --- Top Contributors [![Blair2004](https://avatars.githubusercontent.com/u/5265663?v=4)](https://github.com/Blair2004 "Blair2004 (101 commits)") ### Embed Badge ![Health badge](/badges/nexopos-core/health.svg) ``` [![Health](https://phpackages.com/badges/nexopos-core/health.svg)](https://phpackages.com/packages/nexopos-core) ``` PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)