Skip to content

Installation Guide

Development Environment

Basic

The easiest way to get started developing locally is to use either Laravel Herd, or Laragon. Reference Laravel's installation docs to learn more. It's recommended to use the Laravel Installer installation option for this type of environment.

Docker

If you want more flexibility and already have Docker knowledge, this starter kit provides a streamlined Docker development setup to get you up and running in no time. You'll want to use the Manual (Git) installation option if you don't want/have PHP, Composer, & Node installed on your machine.

Laravel Installer

Setup a new project using the Laravel installer:

bash
laravel new your-project-name --using=connora/laravel-primevue-starter-kit

Composer

If you don't want to use the Laravel installer, you can use Composer directly:

bash
composer create-project connora/laravel-primevue-starter-kit your-project-name

The Composer scripts should handle all the PHP/Laravel related setup, all you'll need to do is install the npm dependencies:

bash
npm install

Manual (Git)

Clone directly from source repository:

bash
git clone https://github.com/connorabbas/laravel-primevue-starter-kit.git your-project-name
bash
git clone git@github.com:connorabbas/laravel-primevue-starter-kit.git your-project-name

Alternatively:

Follow the Manual Setup steps.

Setup

  1. Navigate to the project directory:

    bash
    cd your-project-name
  2. Copy the .env.example file to create a .env file:

    bash
        cp .env.example .env
    bash
        copy .env.example .env
  3. Install Composer dependencies:

    bash
    composer install
  4. Generate an application key:

    bash
    php artisan key:generate
  5. Migrate database tables

    bash
    php artisan migrate
  6. Install npm dependencies:

    bash
    npm install