Installation
How to install and set up your Inertia Start project.
Follow these steps to get your Inertia Start project up and running on your local machine. You can also refer to the official Laravel installation guide for more details.
Prerequisites
Before you begin, ensure you have the following installed on your system:
- PHP 8.3 or higher
- Composer
- Node.js 20 or higher
- NPM or Yarn or Bun
Installation Steps
Download the Project
Download the source code to your machine, either by cloning it (recommended):
git clone git@github.com:inertiastart/inertiastart.gitor by downloading the latest release:
https://github.com/inertiastart/inertiastart/releases/latest
Install Composer Dependencies
cd inertia-start
composer installEnvironment Setup
When running composer install, the .env.example file has been copied to .env.
By default, Laravel will use a SQLite database. If you want to use an existing database, open the .env file and configure your database driver and credentials.
More information on the supported databases and the configuration in the Laravel database documentation.
Example with a MySQL database:
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=laravel
DB_USERNAME=root
DB_PASSWORD=Finally, run the Inertia Start setup command that will ensure everything is ready:
composer run setupThis command will:
- install Composer and Node.js dependencies
- ensure all required files and environment variables exist
- create the database and run migrations
- configure the billing provider
- build the frontend assets
- generate a secure link to create a Super Admin (if one doesn't exist yet)
When run from your terminal, it walks you through the interactive steps (such as choosing your billing provider). When run in a non-interactive environment such as CI, it skips the prompts and performs a deterministic setup.
Serve the Application
For local development, start all the development processes (application server, Horizon queue worker, Reverb WebSocket server, logs, and the Vite dev server with hot module replacement) with a single command:
composer run devVisit the URL displayed in your terminal to view your application.
You can inspect the registered processes at any time with php artisan dev:list.
Serve with Herd
Laravel Herd is a blazing fast, native Laravel and PHP development environment for macOS and Windows. Herd includes everything you need to get started with Laravel development, including PHP and Nginx.
Getting started with Herd.