Skip to content

Latest commit

 

History

History
115 lines (67 loc) · 3.23 KB

local_environment.md

File metadata and controls

115 lines (67 loc) · 3.23 KB

Local Development Environment

Table of Contents

  1. Requirements
  2. Installation
  3. Using Admin Dashboard

Requirements (for local development)

Installation

  • Clone the repo

      git clone https://github.com/mchekin/rpg.git game
    
  • Navigate to the project folder

      cd game
    
  • Create .env file from the .env.example file

      cp .env.example .env
    

    On Windows:

      copy .env.example .env
    
  • Run composer install to import the dependencies and enable auto-loading

      composer install
    
  • Generate Laravel Application key

      php artisan key:generate
    
  • Create SQLite database file

      touch database/database.sqlite
    

    On Windows:

      copy NUL database\database.sqlite
    
  • Run Laravel database migrations and seeds

      php artisan migrate --seed
    
  • Compile frontend assets

      npm install & npm run dev
    
  • Create a symbolic link from "public/storage" to "storage/app/public"

      php artisan storage:link  
    
  • Run PHP build-in development server on the host machine

      php artisan serve  
    
  • Navigate to http://localhost:8000/

  • Enable Laravel Task Scheduling

    1. Open the cron tab file

       crontab -e
      
    2. Add the following line and save

       * * * * * php <path-to-project>/artisan schedule:run >> /dev/null 2>&1
      

    On Windows:

    Open the Terminal as Administrator, navigate to the project's root folder and run:

      schtasks /create /sc minute /mo 1 /tn "RPG SCHEDULER" /tr %cd%\scheduler.bat
    

    To disable the annoying command-line pop-up each time the task runs:

    1. Open Windows "Run" dialog by pressing "Windows Key + r"
    2. Enter type "Taskschd.msc" and press Enter. This will open the "Task Scheduler".
    3. In Task Scheduler's "Active Tasks" section find the "RPG SCHEDULER" task and double-click it.
    4. In the left "Actions" panel click "Properties". This will open "Properties" pop-up.
    5. In the pop-up select the "Run whether user is logged in or not" and press Enter. You maybe asked for your Windows user's password to complete the process.

    To remove the scheduled task you can use

      schtasks /delete /tn "RPG SCHEDULER" /f
    

Using Admin Dashboard

Voyager has been integrated into the project as an Admin Dashboard.

To use the Admin:

  • Register a user in the application (You can skip this step if you already have a user).

  • Give the user the admin role by running:

      php artisan voyager:admin <user email>
    
  • Navigate to http://localhost:8000/admin.

  • Log in with the user credentials (If not logged in automatically).

Further information about using Voyager can be found on its official website.