Installation Documentation - Kitchora Smart Restaurant System

1. System Requirements

Before you begin, please ensure your server meets the following minimum requirements to run the application smoothly:

PHP Version: 8.2 or higher
PHP Extension: imagick (Required for image processing)
Database: MySQL or MariaDB
Dependency Manager: Composer installed
Web Server: Apache or Nginx

Recommended Settings: We recommend using an SSL certificate (HTTPS) for security and ensuring your server has at least 512MB of RAM available.

2. Preparing Files & Database

Upload Files

Download the main zip file from Envato/CodeCanyon.
Extract the contents to your computer.
Upload the contents of the project folder to your server's public root directory (e.g., public_html or www) via FTP or your hosting File Manager.

Create Database

Log in to your hosting control panel (cPanel, Plesk, etc.).
Go to the MySQL Databases section.
Create a new, empty database (e.g., kitchora_db).
Create a new database user and assign it to the database with All Privileges.

Permissions

Ensure the following directories are writable (Permission 775 or 755):

storage/ (and all subdirectories)
bootstrap/cache/

3. Accessing the Setup Wizard

Once your files are uploaded and the database is created, open your web browser and visit your domain name (e.g., https://yourdomain.com).

You will be automatically redirected to the Kitchora Setup Wizard. The wizard consists of 7 easy steps shown on the left sidebar.

4. Installation Steps

Step 1: Application Requirements

The first screen checks if your server meets the technical requirements.

PHP ^8.2
PHP extension: imagick

If all requirements show a green OK status, click Continue.

If any requirement fails, please contact your hosting provider to enable the missing extension or update PHP version. After fixing, click Recheck.

Step 2: Database Configuration

Enter the database details you created earlier:

Field	Description	Example
Database Host	Usually `127.0.0.1` or `localhost`	127.0.0.1
Database Port	Default MySQL port	3306
Database Name	Name of the empty database	kitchora_db
Username	Database user with privileges	root_user
Password	Password for the database user	******

Click Test Connection. You should see a green Connected! message.

If successful, click Save & Continue. If it fails, double-check your credentials.

Step 3: System Basics

Configure the basic settings for your application environment:

Application Name: The name of your site (e.g., Kitchora).
Application URL: The full URL where the app is installed (e.g., https://yourdomain.com/).
Timezone: Select your local timezone for accurate reporting.

Click Next Step to proceed.

Step 4: Company Information

Enter your business details. These will appear on invoices and reports:

Company Name: Your restaurant or business name.
Phone: Contact number.
Address: Physical address.
Logo: (Optional) Upload your business logo. Supported formats: PNG, JPG.

Click Next Step to continue.

Step 5: Administrator Account

Create the primary administrator account (Super Admin). This login will have full access to the system.

Full Name: e.g., Admin User
Email Address: This will be your login username.
Password & Confirm Password: Choose a strong password.

Make sure to remember these credentials as you will need them to log in immediately after installation.

Click Next Step to continue.

Step 6: Features & Data

Select the operational modules you want to enable:

Dine-in: For table management and in-house orders.
Delivery: For tracking delivery orders.
Takeaway: For pickup orders.

Experience Data Import:

Check Import Demo Data if you want to populate the system with dummy menus, tables, and items for testing purposes.

For a live production site, we recommend unchecking Import Demo Data to start with a clean database.

Click Next Step.

Step 7: Review & Finish

Review the summary of your settings (App Name, Database Info, Admin Email, Features).

If everything looks correct, click Finish Setup.

The system will now run the final installation tasks (migrations, seeding, etc.). This may take a few seconds.

5. After Installation

Once the setup is complete, you will see a success message and be redirected to the login page.

Login URL: https://yourdomain.com/login
Credentials: Use the Admin Email and Password you created in Step 5.

First Steps Recommended:

Log in to the Admin Panel.
Go to Settings to configure units and currency.
Create your first Branch (if applicable).
Set up your Menu Categories and Items.

6. Troubleshooting

Common issues you might encounter:

Requirements Check Fails

If the wizard shows a red "X" for PHP or Imagick, you must fix this on your server before proceeding. Contact your server administrator or hosting support to install the missing extensions.

Database Connection Error

If the connection test fails, verify that your database name and password are exactly correct. Ensure your database user has permission to access the specific database.

500 Error / Blank Page after Finish

This is often due to directory permissions or a timeout.

Check that storage/ folder permissions are set to 775.
Check your server's error logs (e.g., error_log file) for specific details.

7. Support & Updates

If you need further assistance with the installation, please open a support ticket via our Envato profile page or email us directly.

Important: Always keep a backup of your database and files before installing updates or making significant changes.

Thank you for choosing Kitchora!