How to Install Waravel

Prerequisites

Before we begin, ensure your environment meets these requirements:

• PHP: Version 8.2 or higher.
• Laravel: Version 10 or 11+.
• Extensions: GD (for images) and Zip.
• Access: Terminal/SSH access to your server.

---

Get Started

1. Prepare Your Application

If you don't have one yet, install Laravel on your server, or use your existing Laravel application.

2. Configure Environment

We need to register your license and the repository.

Update .env

Locate the .env file in your root directory and add your license key at the end:

WARAVEL_LICENSE_KEY=your_waravel_license_key_goes_here

Update composer.json

Locate composer.json in your root directory.

First, add the private repository reference:

"repositories": [
    {
        "type": "composer",
        "url": "https://packages.waravel.com"
    }
]

Then, add the requirement (or run the command in the next step):

"require": {
    "sobberrc/waravel": "^1.0"
}

3. Install via Terminal

Run the following commands in order:

Require the package:

composer require sobberrc/waravel

Run Database Migrations:

php artisan migrate

Run the Waravel Installer:

php artisan waravel:install

*Follow the prompts on screen to enter your Admin Name, Email, and Password.*

Link Storage:

php artisan storage:link

4. You're Done!

You can now access your dashboard at any of the following:

• /waravel
• /wv-admin
• /waravel-login

Enter the email and password you created during installation to log in.