Ninshiki Backend Documentation Help

Installation for Production

Pre-requisite

PHP Extension

  • PHP >= 8.2

  • Ctype PHP Extension

  • cURL PHP Extension

  • DOM PHP Extension

  • Fileinfo PHP Extension

  • Filter PHP Extension

  • Hash PHP Extension

  • Mbstring PHP Extension

  • OpenSSL PHP Extension

  • PCRE PHP Extension

  • PDO PHP Extension

  • Session PHP Extension

  • Tokenizer PHP Extension

  • XML PHP Extension

  • Intl PHP Extension

Email Notification

Create an account in RESEND for email services.

CDN

Create an account in Cloudinary for Image CDN.

Installation

  1. Clone the repository

git clone git@github.com:MarJose123/Ninshiki-backend.git

  1. Copy the .env.example to .env

  2. Update the Laravel Reverb Key by providing a unique key and App Key.

php artisan reverb:key

  1. Update your Cloudinary CLOUDINARY_URL and RESEND_KEY.

  2. Install dependencies

composer install

  1. Generate App Key

php artisan generate:key

  1. Run Database Migration and Seeder

php artisan migrate

  1. Create a user with a permission of an Owner/Administrator

php artisan make:ninshiki-user

  1. Generate Reverb Key

php artisan reverb:key

  1. Now your backend is ready for integration with your frontend.

Last modified: 17 August 2024
Installation for Development/LocalDeployment