Page header banner

Quickl Documentation

Web Documentation#

Introduction

QuicklAI contains varieties of modules to set up web and mobile app, so to make
successful connection & installation for your app by your own then it’s necessary
To have a basic knowledge in both server side and mobile app development.

  • 1. Real server Server related knowledge like apache or local machine server, we preferred to use a real server
  • 2. Server related knowledge and we preferred cPanel in your server for quick installation
  • 3. Basic knowledge in PHP, Laravel and Flutter if you want to do some customization yourself (Not compulsory).
  • 4. basic knowledge about google cloud and firebase

Server Requirement#

Requires PHP v8.0+
Mod_rewrite Apache

Admin panel setup#

How to set up Quickl admin panel on your server?

Step 1:

After downloading the code, extract the given zip file and upload the
quickl_admin_panel.zip file in your server following your expected directory and extract the zip file. admin panel can be installed on a domain or subdomain: For Example, yourdomain.com OR admin.yourdomain.com OR yourdomain.com/admin

Step 2:

Create a new database from your server MYSQL database

Step 3:

Create a DB user to the database and link that database to the DB user

Step 4:

Update your database credentials (DB_DATABASE, DB_USERNAME
&DB_PASSWORD) to.env file which exist at root path of admin panel

Step 5:

Run the following commands from your project root terminal

php artisan key:generate

php artisan migrate

php artisan db:seed

Important Note:

Please use the generated application key to your app otherwise your application will not work. You can see generated application key at .env file of admin panel root path

Now you can access your admin panel at the desired domain.

Application Set up#

Change App Name

Change the value of label from /android/app/src/main/AndroidManifest.xml

Change the value of CFBundleName from /iOS/Runner/info.plist

App Subscriptions for iOS & Android using RevenueCat

For subscription creation in android and ios please use the below youtube link
and also refer to the revenueCat documentation

video

Revenuecat documentation :- https://www.revenuecat.com/docs

After generating Subscription key as per above video please add subscription key In

admin -> Subscriptions – > click on Create Subscription – > add here.

Note:

Please make sure every subscription plan key is different for both platforms (Android and IOS).

Change Base URL

Must remember that don’t put slash(/) at the end of your base url. Use your admin url as base url. First you have to install your admin panel. For example: If your admin url is https://your_domain.com/admin then base url will be https://your_domain.com. Open /lib/service/api_services.dart and replace baseUrlOfAPI variable value with your own URL.

Also please replace api key apiKey. Please refer to the web document for how to create APIkey.

Change App Package

First you have to find out the existing package name. You can find it out from the top of the /app/src/main/AndroidManifest.xml file. Now on the right side of the project folder from VSCode. In the first box you have to put the existing package name that you saw in the AndroidManifest.xml file previously and write down your preferred package name in the second box and then click on Replace All button.

App build & release

Build for Android

For debug build you can run command:

flutter build apk

You will get a larger merged apk with this. But you can split them with this command:

flutter build apk –target-platform android-arm,android-arm64,android-x64
–split-per-abi

Build file location: /build/app/outputs/flutter-apk/ For deploying it please follow this documentation: https://docs.flutter.dev/deployment/android

Build for iOS

here is no general way to generate apps for iOS. Apple doesn’t allow you to install apps like this. If you want to install it on your iOS device then you have to deploy it on TestFlight or AppStore. For deploying it please follow this documentation:

https://docs.flutter.dev/deployment/ios

Landing page setup#

Step 1:

After downloading the code, extract the given zip file and upload the quickl_landing_panel.zip file in your server following your expected directory and extract the zip file. Landing panel can be installed on a domain or subdomain: For Example, yourdomain.com OR landing.yourdomain.com OR yourdomain.com/landing

Step 2:

Update your database credentials (DB_DATABASE, DB_USERNAME
&DB_PASSWORD) to.env file which exist at root path of landing panel

Note:

Please use the same database credentials which you have added for the admin
panel.

Step 2:

Run the following commands from your project root terminal

php artisan key:generate

php artisan migrate

Now you can access your landing panel at the desired domain.