Getting Started

We have crafted a kickstart template for you to quickly get up and running with NinjaPortal.
You can clone the kickstart template from our GitHub repository.

git clone https://github.com/ninjaportal/kickstart.git

once you have the kickstart template, run the following commands to install the dependencies and start the development server

cd kickstart
composer install

Then copy the .env.example file to .env and update the database configuration to match your local setup.

cp .env.example .env

Now seed the database with the default settings and RBAC roles and permissions, and start the development server.

php artisan portal:seed --settings --rbac # Seed the database with default settings and RBAC roles and permissions
php artisan serve

INFO

If you want to add NinjaPortal to your existing Laravel project, just install the ninjaportal/portal package via composer and follow the configuration steps in the documentation.

The kickstart contains the basic setup of NinjaPortal, including the shadow-theme package, which is a simple and clean theme that you can use as a starting point for your portal, also it's packed with a Filament admin panel.