Environment Setup

  • Required PHP version 8.1
  • Enable this on your server before proceeding in PHP openssl, pdo, mbstring, tokenizer, JSON, CURL.
  • In Apache enable "mod_write" for guidance follow this click here
  • In Config enable "allow_url_fopen" for guidance follow this click here

Points to Remember

  1. Please be prepared with database name, database username name and database password.
  2. Create and set up an Onesignal account and update keys in admin settings.
  3. Create and set up email settings so your email can work.
  4. Setup a deep link setting so that your notifications will work properly.
  5. Translation using Chat GPT or Google Translation will work only after adding a keys make sure you have keys.
  6. Setup a deep link setting so that your notifications will work properly.
  7. Social media login for front end update keys in admin settings.
  8. Admob will work only when keys are added in admin settings.
  9. For facebook ads working have to add keys in admin settings.
  10. To approve comments automatically enable setting in the Global settings tab.

    11. Note : Above all setup is necessary if you won’t enable any of them that will cause not functioning properly.
  11. Upload the downloaded laravel code file from codecanyon.

Installation

  1. Login to your panel and search for "File Manager" and open it.
  2. Go to “public_html” and then click on “Upload” then upload the provided zip file on the server when the file is uploaded and extract that zip file there.
  3. Once previous steps are done open the domain URL in a new tab.
  4. On opening the site, you will get the setup wizard. Click "Check Requirements"
  5. On the Permission, click next step which is "Check Permissions"
    6. Note : If your folders don't have write permission go through all 3 sections. Change permission to 775 and reload this you can find all options to turn red to green and the button for proceeding to the next step will be visible.
  6. Click on "Form Wizard Setup".
  7. Fill your "App Name" which is a mandatory field this defines the name of your project.
    For "App URL" just copy the URL of your domain and paste it here.
    8. Note: Set the 'debug' to 'true' in the '.env' file to clearly display errors in the project. If 'debug' is set to 'false' and an error occurs, only a 500 error page will be shown. You can adjust this setting in the '.env' file at any time.

Database Configuration

  1. For the next step, configure the "database settings" on your CPanel. Follow the steps in my CPanel: Go to "MySQL Manager".
  2. Click on “Add Database”.
  3. Next,"add credentials" and "create a new user" for your database.
  4. Then provide all privileges and save these credentials.
    5. Note: Before saving, copy the database name, username, and password one by one. Save them into Notepad or keep a record, as we'll need these credentials for the next step. Without them, you won't be able to proceed.

Application Setup

  1. After creating the database credentials, use them in the next step. Put the credentials in the respective fields and click on 'Setup Application'.
  2. Click on 'Install'
  3. When the popup appears with 'Installation success' at the top, click on 'Click here to exit.' You will be redirected to the next step.
  4. In this step, enter the 'purchase code' received from CodeCanyon license. Put your purchase code and click on 'Verify'.
  5. When the verification is successfully done, you will be redirected to this page.
    From here, please copy and save the admin credentials so you can log in during the next step.
  6. Enter the email and password of the admin that you saved from the previous step.
  7. Once you have successfully logged in, everything is set up, and you are good to go. Congratulations! 🎉🥳

Update Process

Effortlessly keep your website up-to-date with our seamless automatic update process. Simply access the 'Update Website' option, click the 'Update Website' button, and your site will be refreshed with the latest enhancements and database changes. Stay current effortlessly!"

Automatic

  1. In the 'Automatic Update' process, when we push any updates to our system, this menu in the sidebar displays the count.
  2. Navigate to the 'Update Website' option, where you'll find the 'Update Site' button. Clicking on this button will update your site with our latest changes, including any database updates.
  3. After your site is updated, the sidebar and page will appear as shown in the screenshot below, with the count in the sidebar disappearing and the 'Update Website' button no longer visible.

Manual

If the automatic update process did not work or you have an old code version, follow these steps to manually update your code:

  1. Download the 'update.zip' provided for the code update and extract the contents.
  2. Copy and paste the folders from the extracted files into the root folder of your code.
  3. Additionally, we will provide a file with queries. Copy the queries, go to 'MySQL', and open your database. Once your database is open, you will see all your tables. Click on the 'SQL option'.
  4. When the SQL option opens, paste all of your queries and click 'Go' to execute them. Your website is now updated with our latest changes. You're good to go!
    5. Note: In both update processes, if you have made any manual changes in the code other than our provided code, it is highly suggested not to update your website using any of the update processes, as it may result in the loss of your custom changes.

Rate Us Settings

  1. From the Sidebar, Open "Settings" section and then Click on "Translation Settings".
    2. You will find two fields for PlayStore Url ( Android ) and AppStore Url ( iOS ) respectively.
    You can change url from here to enable "Rate us".

Cron Job Settings

To schedule posts for automatic publishing, you need to create a cron job in hPanel. Follow these steps to set up a cron job :
  1. Access Advanced Options
    2. Log in to your hPanel account and navigate to the Advanced section for the particular domain you want to set up the cron job for.
  2. Access Cron Job Tab
    3. Click on the Cron Jobs tab within the Advanced section.
  3. Configure Cron Job
    • Choose the PHP option as the command type.
    • Enter your domain URL in the Command field.
    • Append the following command to the end of the URL :

      artisan schedule:run

    • The complete command should look like this :

      https://yourdomain.com/artisan schedule:run


  4. Set Scheduler Run Time

      5. Choose how often you want the scheduler to run from the following options:

    • Every minute
    • Every hour
    • Every day
    • Every weekday
    • Every week

Basic App Setup

  1. Open Terminal
  2. To make sure your configurations are all set to run this project
    3. flutter doctor -v
  3. To make sure you are running the mentioned version given in the documentation
    4. flutter --version

    Flutter version : 3.4.3 <= 4.0.0 | Dart version : 3.5.3

    flutter clean
    and then run
    flutter pub get

  4. Navigate to "lib/urls/url.dart"and change values for "baseUrl = "https://your.server-url.com/api/" and "baseServer = "https://your.server-url.com/" as per your server domain.

    5. See attached screenshot below :

How to change app icon for iOS and Android ?

  1. Click on appicon.co to generate icons
    2. ( Note: Preferred image resolution to upload is 1024*1024 )
  2. After generating files, you can find these files :

  3. Open your project, and go to 'android/app/src/main/res/' file inside your project

  4. Replace below folders :
    5. For Android :
    • mipmap-hdpi
    • mipmap-mdpi
    • mipmap-xhdpi
    • mipmap-xxhdpi
    • mipmap-xxxhdpi
    For IOS :
    • Assets.xcassets
    How to change app icon within app ?
    In your project directoty, go to assets/img/ and replace all app icons to your desired icon. ( Note : Remember to keep the same name of image and resolution ).
      • appicon.png (512 × 512)
      • com_logo.png (600 × 600)
      • logo.png (408 × 115)

How to change Notification badge icon for android app ?

  1. Open your project, and go to android/app/src/main/res/ file inside your project
  2. Replace below folders :
    • To generate notification assets click given link : Generate Notification assets
    • android/app/src/main/res/drawable-mdpi/ic_stat_onesignal_default.png
    • android/app/src/main/res/drawable-hdpi/ic_stat_onesignal_default.png
    • android/app/src/main/res/drawable-xhdpi/ic_stat_onesignal_default.png
    • android/app/src/main/res/drawable-xxhdpi/ic_stat_onesignal_default.png
    • android/app/src/main/res/drawable-xxxhdpi/ic_onesignal_large_icon_default.png

Notification Icon for Firebase

  • Place this app icon with name "notification_icon" at "android/app/src/main/res/drawable/notification_icon.png"

How to change App Name & Bundle Id?

How to change App Name ?
  • In your project directory, go to "android/src/main/res/androidmanifest.xml".
    Find android:label="Incite" and replace Incite" to "{App-Name}"

How to change Bundle Id ?

  • Under Incite Project, Go to "android > app > build.gradle"
  • Under Incite Project, Go to "android > app > src > main > Kotlin > MainActivity.kt"

How to Create App Signing Key


      Before key creation, please read the instruction below :
    1. Delete the key.jks given in the project given at android/app/key.jks. It is just a dummy key for explanation.
    2. Please remember to add key.jks file under android/app/key.jks to avoid errors in the project setup.

    Why need app Signing key

    • With Play App Signing, Google manages and protects your app's signing key for you and uses it to sign optimized, distribution APKs that are generated from your app bundles. Play App Signing stores your app signing key on Google's secure infrastructure and offers upgrade options to increase security.
  1. Running the following at the command line: On macOS or Linux, use the following command:
    keytool -genkey -v -keystore ~/key.jks -keyalg RSA \ -keysize 2048 -validity 10000 -alias upload
    On Windows :
    • Open command prompt, at folder 'android/app' in your project directory.
    keytool -genkey -v -keystore key.jks -storetype JKS -keyalg RSA -keysize 2048 -validity 10000 -alias upload
  2. Details to Fill When Creating key.jks
    1. Keystore Password: This is the password for the keystore file (key.jks). Make sure to choose a strong and secure password and remember it because you'll need it for future app updates and releases.
    2. Alias Name: The alias is a name for the key within the keystore. You'll use this alias to refer to the key when signing your app. You can choose any name you like for the alias.
    3. Key Password: This is the password for the key itself. It can be different from the keystore password. Again, choose a strong and secure password.
    4. First and Last Name: Your first and last name or the name of the organization responsible for the app.
    5. Organizational Unit: The unit within the organization that is responsible for the app (e.g., Development Team).
    6. Organization: The name of the organization responsible for the app.
    7. City or Locality: The city or locality where the organization is located.
    8. State or Province: The state or province where the organization is located.
    9. Country Code: The two-letter country code according to ISO standards (e.g., US for United States, IN for India).

    When you run the keytool command to generate the key, it will prompt you to enter these details interactively. Once you've provided all the necessary information, the key.jks file will be generated with the specified alias and stored in the directory you've chosen. Make sure to keep the keystore file and the passwords secure, as they are crucial for signing and updating your app.

  3. After Key.jks file creation, Add 'storePassword' & keyPassword in your key.properties file under android folder of your project.

Admin Settings to App (Both Android & iOS)

  • Change App Color
  • App under Maintenance
  • Add Live News & E-News on App Dashboard
  • Enable ADS
  • Change In-App Icon

IOS setup for Incite

Basic Setup

  1. Navigate to https://appleid.apple.com/sign-in and login to your apple account.
  2. In your Project folder, Open "ios" folder,
    Double-Tap on "Runner.xcworkspace" to open "Xcode"
  3. Click on "Team section", then Click +"Add an Account" and Login to your Apple account
  4. Setup provisioning profile on xcode
  5. Open Terminal and perform basic operations before going forward.
    Please use commands below :
    6. flutter clean
    and then run
    flutter pub get
    now run
    pod install

How to change App Icon (IOS) ?

Note : Before followiing this step, Please make sure you followed App Icon step.
  • Copy Assets.xcassets
  • Replace Assets.xcassets inside ios/Runner

How to change Bundle Identifier and App Name ?

  1. Open Xcode, Under "General tab" Look for :
    • (a) Bundle Identifier field and replace it.
    • (b) In your project directory, go to "ios/runner/info.plist". Find "CFBundleDisplayName" & "CFBundleName", Replace Signal" to yourApp-Name

Enabling Share Settings (iOS)

  1. Go to 'ios/Runner/info.plist'
  2. Change 'com.incite.app' given under 'CFBundleURLName' and change it with 'your.custom-url.example'. It is the host of your deep link.
  3. Do the same in the Admin section, Go to Dashboard > Settings > Share Settings, 'iOS Schema' to add ios://your.custom-url.example, where 'ios' is the 'schema' and 'your.custom-url.example' is your host

Firebase Configuration (iOS)

  1. Open your firebase project and Click on "Project Settings"
  2. Scroll down and Click on Add App
  3. Then select platform for your app which is "iOS"
  4. Now, Enter your bundle ID ( Bundle Identifier ) and Click "Next"
  5. Download GoogleService-info.plist and replace in your "ios/Runner/GoogleService-info.plist", Click "Next"
  6. Click Next and proceed till Step 3 > Step 4 > Step 5 then Click on "Continue to Console"
How to enable IOS Push Notifications (Flutter/Firebase) ?
  1. Push notification setup for iOS
  2. Refer to OneSignal iOS, then click on "Activate" iOS
    3. Note : When you follow link, Remember to :
    • Make sure you follow "OneSignal setup for incite"
    • Add p8 certificate (not p12 certificate) which you have generated from Apple developer account.
    • Follow this documentation for One Signal only.
  3. Get Team ID from iOS developers account
  4. Select iOS Sdk and proceed

How to create build and release iOS App ?

Follow this link : Build and release iOS App

In App Force Update ( IOS )

  1. From the Sidebar, Open "All Settings" section and then Click on "Is IOS Force Update".
    2. You will find a toggle, when "enabled" it will let users force to update app if user is not updated to latest app version.
    If "disabled" then users can choose whether to use same app version or update to latest.

Existing Project Changes

    Please remember while replacing this folder : If you have made customisations by yourself then we don't recommend this process.

      We have categorize changes in two variation :
    1. Minor updates
    2. Major updates

    Minor Updates

  • Replace "lib" folder with the newly updated code's "lib" folder
  • Navigate to "lib/urls/url.dart"and change values for "baseUrl = "https://your.server-url.com/api/" and "baseServer = "https://your.server-url.com/" to your server domain.

    • See attached screenshot below :

  • Go to main.dart, look for OneSignal.initialize("here add your onesignal app id") in the code at line 126. Add the notification that you have for your project
  • Replace "pubspec.yaml" file, before it please make sure you know the your app version. Please preserve it and after replacing pubspec.yaml file update the app-version (1.0.0+1) with your desired app version.

    • Major Changes (Rare Cases when major flutter version updated)

  • Before following major changes. Please follow the "Minor changes" given above
  • Replace "android/gradle/wrapper/gradle-wrapper.properties"
  • Replace "android/build.gradle"
  • Replace "android/app/build.gradle"
  • Replace "android/gradle.properties"
  • Replace "android/app/src/main/Androidmanifest.xml"
  • Place this app icon with name "notification_icon" at "android/app/src/main/res/drawable/notification_icon.png"

    • After replacing app/build.gradle file, do not forget to update the "bundle-id" of your project inside the file.

  • Replace "android/setting.gradle"
  • Place this file at "lib/enable_notification.dart"