README

Ninshiki Web App; Inspiring Recognition: Celebrate Success

Installation

You can install the package via composer:

composer require ninshiki-project/ninshiki

Install the ninshiki

php artisan ninshiki:install

You can publish the config and assets file with:

php artisan ninshiki:publish

Keeping Ninshiki’s Assets Updated

To ensure Ninshiki’s assets are updated when a new version is downloaded, you may add a Composer hook inside your project’s composer.json file to automatically publish Ninshiki’s latest assets:

"scripts": {
    "post-update-cmd": [
        "@php artisan vendor:publish --tag=laravel-assets --ansi --force",
+        "@php artisan ninshiki:publish --ansi"
    ]
}

Known Issue

Increasing the NGINX buffer size for Inertia requests

Because of a known issue with Inertia.js and default NGINX configuration, you may need to increase the buffer size for NGINX to handle Inertia requests.

server {
    listen 80;
    listen [::]:80;
    server_name example.com;
    root /srv/example.com/public;
 
    add_header X-Frame-Options "SAMEORIGIN";
    add_header X-Content-Type-Options "nosniff";
 
    index index.php;
 
    charset utf-8;
 
    location / {
        try_files $uri $uri/ /index.php?$query_string;
    }
 
    location = /favicon.ico { access_log off; log_not_found off; }
    location = /robots.txt  { access_log off; log_not_found off; }
 
    error_page 404 /index.php;
 
    location ~ ^/index\.php(/|$) {
+       fastcgi_buffer_size 8k;    
        fastcgi_pass unix:/var/run/php/php8.2-fpm.sock;
        fastcgi_param SCRIPT_FILENAME $realpath_root$fastcgi_script_name;
        include fastcgi_params;
        fastcgi_hide_header X-Powered-By;
    }
 
    location ~ /\.(?!well-known).* {
        deny all;
    }
}

Testing

composer test

Development

Always build the assets by running this command

 npm run build

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• MarJose123
• All Contributors

License

The MIT License (MIT). Please see License File for more information.