Getting Started

Installation of Heave AI is basically same as Laravel. In addition, we offer an installation wizard so you can install Heave in a few clicks.

System Requirements

Under the hood, Heave using Laravel 10, Heave AI requires nothing more than a regular Laravel.

- A web server (Apache, Nginx)
- A database (MySQL, PostgreSQL, SQLite, MariaDB)
- PHP >= 8.1
- BCMath PHP Extension
- Ctype PHP Extension
- Fileinfo PHP extension
- JSON PHP Extension
- Mbstring PHP Extension
- OpenSSL PHP Extension
- PDO PHP Extension
- Tokenizer PHP Extension
- XML PHP Extension

Installation

  • Extract and upload app.zip folder to your server (your virtual host should point to the /public directory instead of project root directory).
  • Open your website URL, the installation wizard will show up for you like this: Installation - Config
  • Enter your database credentials, select your desired language and click "Continue" button.
  • The next step is to create your admin account. Enter your credentials and click "Finish" button. Installation - Finish
  • Now you can login to your dashboard with your created credentials.

In case installation wizard can't write to .env file, you'll get this message, follow the instructions to fix it: Installation - Error

Directory Permissions

In case you receive 500 server error, you should check your directory permissions. Make sure that storage and bootstrap/cache directories are writable by your web server.

Post Installation

Now you can login to your dashboard with your created credentials. Installation - Error Go to Settings and feel free to customize your app as you want.

Setting up OpenAI API Key

  • Go to Open AI Platform and click "Create new secret key" button.
  • Copy your secret key and go to Settings\AI Integrations page in your dashboard. AI Integrations

Congratulations, you have successfully installed Heave AI!

For more information and preferences, please visit our online documentation.