PrimeDash

Appearance

On this page

Quick Start ​

Prerequisite ​

  • Node LTS version is required
  • PHP 8.2.0 or greater version is required
  • Any Package Manager (NPM | Yarn | PNPM)

Getting started ​

  • Download and unzip our Package

  • Navigate to the Full-version Or Starter-kit or Starter-kit with InertiaJs folder

  • Open the folder in your desire code editor and run below command

    bash
    Composer install

  • In the root directory, you will find a file named .env.example rename the given file name to .env and run the following command to generate the key (You can also edit your data base credentials here)

    bash
    php artisan key:generate

  • By running the following command, you will be able to get all the dependencies in your node_modules folder:

    bash
    # For Yarn
yarn

# For npm
npm install --legacy-peer-deps

  • You can run the development server via the dev command, which is useful while developing locally. The development server will automatically detect changes to your files and instantly reflect them in any open browser windows.

    bash
    # For yarn
yarn dev

# For npm
npm run dev

  • To serve the application you need to run the following command in the project directory. (This will give you an address with port number 8000)

Now navigate to the given address you will see your application is running.

bash
php artisan serve

Generating build for production ​

Running the build command will version and bundle your application's assets and get them ready for you to deploy to production:

bash
# For yarn
yarn build

# For npm
npm run build

For InertiaJs Starter-kit only ​

  • Database: setup your database credential in .env file.
env
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=laravel
DB_USERNAME=root
DB_PASSWORD=
  • Run Migration: We have provided basic migration that creates some fake users to be used in the User list page.
bash
php artisan migrate --seed
  • Now, setup you mail credential in .env file.
env
MAIL_MAILER=log
MAIL_HOST=127.0.0.1
MAIL_PORT=2525
MAIL_USERNAME=null
MAIL_PASSWORD=null
MAIL_ENCRYPTION=null
MAIL_FROM_ADDRESS="hello@example.com"
MAIL_FROM_NAME="${APP_NAME}"

If you don't want to set up your email right now, then you need to disable the email verification feature in the User Model. app/Model/User.php

diff
- class User extends Authenticatable implements MustVerifyEmail
+ class User extends Authenticatable