Browse the docs

Installing Laraplate

Laraplate is a Laravel application split into modules. This guide gets a local copy running. It is a work in progress: do not use it in production yet.

Requirements

  • PHP 8.5 or newer
  • Composer
  • Node.js, for the Vite build
  • A database. The default connection in .env.example is PostgreSQL.
  • Redis with the phpredis PHP extension. .env.example uses Redis for sessions, cache and queues (SESSION_DRIVER, CACHE_STORE, QUEUE_CONNECTION, REDIS_CLIENT=phpredis). Without Redis, change those values in .env before you seed or sign in.

Get the code

The modules are Git submodules, so clone with them:

git clone --recurse-submodules https://github.com/getlaraplate/laraplate.git
cd laraplate

Install

# PHP packages
composer install

# Environment file and application key
cp .env.example .env
php artisan key:generate

Open .env and set the DB_* values to your database. Then prepare it and build the assets:

# Database
php artisan migrate:fresh
php artisan db:seed
php artisan module:seed --all

# Frontend assets
npm install
npm run build

The seeders create the roles, permissions and settings the backoffice needs. migrate:fresh drops every table, so run it only on a database you can lose.

Run it

php artisan serve

The backoffice is at /admin. See the three HTTP surfaces for what else the application answers on.

Next

Pick the modules you need in choosing modules, or read the README on GitHub for the main environment variables.

100%