​
Requirements

Before getting started, make sure you have installed PHP 8.3+, Node.js 21+, Nginx or Apache server, and (optionaly) one of the supported database services: SQLite 3.26+, MySQL 5.7+, PostgreSQL 10.0+, MariaDB 10.3+ or SQL Server 2017+.
You should also have Composer (dependency manager for PHP) installed.

​
Laravel Herd

Laravel Herd is highly recommended local development tool for Laravel. It’s very simple to setup and it provides all of the requirements to run (and much more).
It’s available for MacOS and Windows.

​
Homestead

Instructions coming soon…

​
WAMP

Instructions coming soon…

​
Setup

Open your terminal, and run those commands to get started.

​
Clone repository

git clone git@github.com:butchr/laravel-starter-kit.git [APP_NAME]

​
Go to your App folder

cd [APP_NAME]

​
Create environment file

cp .env.example .env

​
Setup database credentials

By default, is using SQLite as database connection.

To change database name (default is database.sqlite) set the variable in your .env. Make sure to enter the correct path.

DB_DATABASE="/code/butchr/database/butchr.sqlite"

To use different database connection, feel free to update the variables accordingly.
This is example for MySQL connection, but you can use any of the supported services.

DB_CONNECTION=mysql
# DB_HOST=127.0.0.1
# DB_PORT=3306
DB_DATABASE=butchr
DB_USERNAME=root
DB_PASSWORD=root

​
Generate application key

php artisan key:generate

​
Install PHP packages

composer install

​
Install JS packages

npm ci

​
Enable public access to storage folder

php artisan storage:link

​
Build CSS and JS

npm run dev

​
Run local server

If you use Laravel Herd you don’t need to run local server since Herd will create a local domain for your application.

Open new terminal tab or window and start your app.

php artisan serve

Visit http://127.0.0.1:8000/ and see your application.

​
Quick installation

Once you have setup your .env file, run this command and follow the steps.

php artisan app:init
IntroductionDevelopment