Installation

Bisavel can be installed in just a few minutes. Whether you're building a new application or exploring the framework for the first time, this guide will walk you through installing the project, configuring your environment, and starting the development server.

Requirements

Before installing Bisavel, ensure your development environment meets the following requirements.

• PHP 8.2+
• Composer 2.8+
• Node.js 25+
• npm 10+
• MySQL, PostgreSQL, MariaDB, or SQLite
• Git (recommended)

Choose a Starter Kit

Bisavel provides multiple starter templates depending on your preferred frontend stack.

Laravel + Inertia.js - Default

Recommended for modern applications using React.

composer create-project bisavel/starter my-app

Laravel Blade (Ongoing)

If you prefer the traditional Laravel Blade template, install the Blade starter.

composer create-project bisavel/starter-blade my-app

Replace starter-blade with the actual package name if your Blade starter uses a different repository.

Configure the Environment

Move into your project directory.

cd my-app

Copy the environment file.

cp .env.example .env

Generate the application key.

php artisan key:generate

Configure your database credentials inside the .env file.

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=my_database
DB_USERNAME=root
DB_PASSWORD=

Install Frontend Dependencies

Install the JavaScript dependencies.

npm install

Run Database Migration

Create the required database tables.

php artisan migrate --seed

Start the Development Server

Run the development environment.

composer run dev

This command starts:

• Laravel development server
• Vite development server
• Queue worker (if configured)
• Log viewer (if configured)

Once everything is running, open your browser:

http://localhost:8000

Verify the Installation

If the installation was successful, you should see the Bisavel welcome page.

You are now ready to start building your application.

Troubleshooting

Composer dependencies cannot be installed

Ensure your PHP version matches the required version.

php -v
composer -V

Node modules fail to install

Verify your Node.js version.

node -v
npm -v

Database connection failed

Check your database configuration in .env.

DB_HOST=
DB_PORT=
DB_DATABASE=
DB_USERNAME=
DB_PASSWORD=

Then clear the configuration cache.

php artisan optimize:clear

Production Deployment

Before deploying your application to production, make sure to:

• Set APP_ENV=production
• Set APP_DEBUG=false
• Configure the production database
• Run php artisan optimize
• Build frontend assets

npm run build

php artisan optimize

Refer to the Deployment documentation for complete production deployment instructions.

Next Steps

Congratulations! 🎉

Your first Bisavel application is now running.

Continue with the following guides:

• Project Structure
• Configuration
• Routing
• Controllers
• Database & Eloquent
• Authentication
• Authorization
• Deployment