Installation #

This section will guide you through setting up a basic Qaravel documentation site from scratch.

Prerequisites #

To get started with a Quasar application, you need to ensure you have the following prerequisites:

1. Node 12+ for Quasar CLI with Webpack, or Node 14+ for Quasar CLI with Vite.
   • To check your Node.js version, run node -v in a terminal/console window.
2. Yarn v1 (strongly recommended), PNPM, or NPM.
   • To check your Yarn version, run yarn -v in a terminal/console window.

Server Requirements #

Qaravel has specific system requirements. Ensure that your web server meets the following minimum PHP version and extensions:

• Apache, nginx, or another compatible web server.
• PHP >= 8.1
• BCMath PHP Extension
• Ctype PHP Extension
• cURL PHP Extension
• DOM PHP Extension
• Fileinfo PHP Extension
• JSON PHP Extension
• Mbstring PHP Extension
• OpenSSL PHP Extension
• PCRE PHP Extension
• PDO PHP Extension
• Tokenizer PHP Extension
• XML PHP Extension
• Imagick PHP Extension
• ionCube Loader® v13.0

Ensure you have the latest ionCube Loader version for your PHP version.

Installing Quasar CLI #

The Quasar CLI is used for project creation, generating application and library code, and various development tasks.

Install the Quasar CLI globally:

yarn global add @quasar/cli
yarn global add @quasar/icongenie
yarn global add https://github.com/dipaksarkar/quasalang

Create Subdomains/Aliases #

You will need to create three subdomains with document root public_html for api, admin, and app as follows:

api.your-domain-name.com
your-domain-name.com/admin
app.your-domain-name.com

Build Application #

1. Execute the following commands in a terminal/console window:

cp .env.example .env
cp .htaccess.example .htaccess

2. (Optional) Modify .env.frontend.prod:

APP_ENV=Production
APP_NAME=Qaravel
# (API_URL is optional, it will be generated using your app domain)
API_URL=https://api.your-domain-name.com 

3. (Optional) Build the application by executing the following commands:

yarn install
yarn build:prod

Install Procedure (Video) #

Install via GUI #

• Create database and Upload all files into the root folder of your hosting (normally, it is public_html). Without followings:

    /dist
    /node_modules
  

• Go to [your-domain-name.com/install] to start installation.
• Step by step to setup your database conntection, site information and administrator.
• Login and setup your website on Welcome Board.

Add Cron Jobs #

Cron jobs are scheduled tasks that run at predefined times or intervals on your server. They are essential for automating repetitive tasks such as running scripts, maintenance tasks, or triggering specific actions at set times.

# Run Laravel scheduler
* * * * * /usr/bin/php8.2 {project-root}/artisan schedule:run >> /dev/null 2>&1

# Process Laravel queues
*/2 * * * * /usr/bin/php8.2 {project-root}/artisan queue:work --timeout=36000 --stop-when-empty

Remove Dummy Data #

1. Open the SSH terminal on your machine and run the following command:

ssh your_username@host_ip_address

2. Type in your password and hit Enter. Then run following commands:

cd public_html
php artisan migrate:fresh --force