All You Need to Get Started

AIklicks is dependent on PHP version 8.2 or higher and MySQL version 5.7 or later. Additionally, the following server configurations and PHP extensions are necessary:

1. Mod_rewrite for Apache
2. Mod_rewrite for Apache
3. Mod_rewrite for Apache
4. Mod_rewrite for Apache
5. Mod_rewrite for Apache
6. Mod_rewrite for Apache
7. Mod_rewrite for Apache
8. Mod_rewrite for Apache
9. Mod_rewrite for Apache
10. Mod_rewrite for Apache

Typically, these extensions are enabled by default on most servers. However, it is advisable to verify the configuration with your hosting provider to ensure compatibility with the project

1. Install Node.js

   Firebase CLI requires Node.js to be installed.

   1. Download Node.js:
      1. Go to the Node.js official website.
      2. Download the LTS version (recommended for most users).
   2. Install Node.js:
      1. Run the downloaded installer.
      2. Follow the installation steps, ensuring the option "Add to PATH" is selected.
   3. Verify Node.js Installation:
      1. Open Command Prompt or PowerShell.
      2. Run the following commands to verify Node.js and npm are installed:
         1. node -v
         2. npm-v
2. Install Firebase CLI
   1. Open a Terminal as Administrator:
      1. Press Win + S, type Command Prompt or PowerShell, right-click, and select Run as Administrator.
      2. Install Firebase CLI Globally:
         1. Run the following command to install Firebase CLI using npm:
            1. npm install -g firebase-tools
      3. Verify Firebase CLI Installation:
         1. Run this command to check if Firebase CLI is installed successfully:
            1.   firebase --version
         2. This should return the version number of Firebase CLI.
3. Authenticate Firebase CLI
   1. Log In to Firebase:
      1. Run the following command:
         1.      firebase login
      2. This will open a browser window prompting you to log in with your Google account. Ensure you use the same Google account associated with your Firebase project.
      3. Once authenticated, return to the terminal to see the success message.

1. Go to firebase console and then click on add project.
   1. x
2. after that below given step will come. here you have to enter your project details Enter your project name and then press on continue then select email and then press continue.
   1. x
3. after that your project is created
   1. x
4. For android,now first click on android
   1. x
5. after that below given screen will appear, in that you have to enter your packagename and appname and then click register app.
   1. x
6. After that below given screen will appear, now click on download google-services.json
   1. x
7. After that open the file and copy content of file and replace in android > app > google-service.son
   1. x
8. now click on next next and in last step press continue navigate to project dashboard.
9. for ios ,perform below step. now click on add app.
   1. x
10. and then click on ios button in this same as android step will be come here you have to enter your appname then next and on next screen download google service info.plist file
    1. x
11. now copy the content of that file and replace in ios > Runner > GoogleServie-info.plist
    1. x
12. now press next next on firebase console and that's it your project is created on ios.
13. Add SHA Keys (For Android)
    1. Open a Terminal/Command Prompt:
       1. Open your terminal or command prompt.
       2. If you're using Android Studio, you can open the terminal directly in the IDE.
    2. Navigate to the Android Directory:
       1. Go to your Flutter project directory in the terminal.
       2. Navigate to the android folder: cd android
    3. Run the Gradle Command:
       1. Execute the signingReport task: ./gradlew signingReport
    4. View the Output:
       1. The command will generate a detailed report showing SHA-1 and SHA-256 keys for all build variants (debug, release, etc.).
    1. X
14. Access Google Cloud Console
    1. Open your browser and navigate to Google Cloud Console.
    2. Log in using the account associated with your Firebase project
       1. x
15. Navigate to API & Services
    1. On the left-hand menu, click on API & Services
       1. x
    2. From the dropdown, select Credentials.
16. Select the Firebase Project
    1. At the top, ensure you’ve selected the correct Firebase project from the project selector.
17. Show and Copy the API Key
    1. For android
       1. Click on the Show Key button next to your Android API key.
       2. The API key will be revealed. Copy the key to your clipboard.
       1. x
    2. For ios
       1. Click on the Show Key button next to your iOS API key.
       2. The API key will be revealed. Copy the key to your clipboard.
       1. x
18. Add a Sign-In Method in Firebase Authentication
    1. Open Firebase Console
       1. Go to the Firebase Console.
       2. Select your project.
    2. Navigate to Authentication
       1. In the left-hand menu, click on Build.
       2. Select Authentication from the dropdown.
          1. x
    3. Set Up Sign-In Methods
       1. Go to the Sign-in method tab.
       2. You'll see a list of authentication providers available, such as Email/Password, Google, Facebook, etc.
    4. Enable a Sign-In Method
       1. Click on the Email/Password authentication provider.
       2. Email/Password: Toggle the switch to enable and click on save.
          1. x
19. Set Up Storage in Firebase

    Follow these steps to set up and configure Firebase Storage:

    1. Open Firebase Console
       1. Go to the Firebase Console.
       2. Select your project.
    2. Navigate to Storage
       1. In the left-hand menu, click on Build.
       2. Select Storage from the dropdown.
    3. Set Up Cloud Storage

       If this is your first time setting up Firebase Storage:

       1. Click Get Started.
          1. x
       2. Choose your default storage location (preferably close to your app's primary users).
          1. x
       3. Click Done to initialize storage.
    4. Configure Storage Rules
       1. By default, Firebase Storage rules are restrictive.
       2. Go to the Rules tab to configure read and write access.
          1. allow read, write: if true;
             1. x
       3. Click Publish to save the rules.
20. Set Up Cloud Functions in Firebase

    Follow these steps to configure and use cloud functions in your Firebase project:

    1. Navigate to Functions
       1. In the left-hand menu, click on Build.
       2. Select Functions.
    2. Open Firebase Console
       1. Go to the Firebase Console.
       2. Select your project.
    3. Set Up Billing (If Required)

       Cloud Functions often require a billing account for use.

       1. If prompted, click Upgrade to link a billing account.
       2. Select or create a billing account and follow the steps.
    4. Set Up Cloud Function
       1. After enabling, you’ll see the Cloud Functions Dashboard.
       2. If this is your first time setting up Firestore:
          1. Click Get Started.
             1. x
          2. After clicking, you'll see the set up function popup then click on continue button.
             1. x
          3. After that click on Finish button.
             1. x
21. Set Up Firestore Database in Firebase

    Follow these steps to configure and use Firestore in your Firebase project:

    1. Open Firebase Console
       1. Go to the Firebase Console.
       2. Select your project.
    2. Navigate to Firestore
       1. In the left-hand menu, click on Build.
       2. Select Firestore Database.
    3. Set Up Firestore

       If this is your first time setting up Firestore:

       1. Click Create Database.
          1. x
       2. Select your Firestore location (choose a region close to your app's primary users).
          1. x
       3. Choose a Start in production mode and click on create button.
          1. x
    4. Configure Firestore Rules
       1. By default, Firestore Database rules are restrictive.
       2. Go to the Rules tab to configure read and write access.
          1. allow read, write: if true;
             1. x
       3. Click Publish to save changes.
22. Update firebase_options.dart
    1. Update apikey for both android and ios :
       1. For Android, Replace copied andriod api key from google cloud console with existing apikey.
          1. x
       2. For iOS, Replace copied iOS api key from google cloud console with existing apikey.
          1. x
    2. After that to update other values
       1. Go to the Firebase Console and log in using the Google account associated with your Firebase project.
       2. Select your Firebase project from the dashboard.
       3. Navigate to Project Settings:
          1. Click the Settings (gear icon) in the left-hand menu.
          2. Select Project Settings from the dropdown.
       4. Update appId for both android and ios : Under the General tab,
          1. For Android
             1. Under the Your Apps section, locate the Android App.
             2. Click on your Android App to view its details.
             3. Locate the App ID field under the app configuration details.
                1. x
             4. Copy the App ID to your clipboard.
             5. Replace copied App ID from firebase console with existing android appid.
                1. x
          2. For iOS
             1. Under the Your Apps section, locate the iOS App..
             2. Click on your iOS App to view its details.
             3. Locate the App ID field under the app configuration details.
                1. x
             4. Copy the App ID to your clipboard.
             5. Replace copied App ID from firebase console with existing ios appid.
                1. x
       5. Update messagingSenderId for both android and ios :
          1. Under the Cloud Messaging tab, locate the Sender ID field.
          2. Copy the Sender ID to your clipboard.
             1. x
          3. Replace copied Sender ID from firebase console with existing messagingSenderId.
             1. x
       6. Update projectId for both android and ios :
          1. Under the General tab, locate the Project ID field.
             1. x
          2. Copy the Project ID to your clipboard.
          3. Replace copied Project ID from firebase console with existing projectId .
             1. x
       7. Update storageBucket for both android and ios :
          1. In the left-hand menu, navigate to Build > Storage
          2. At the top of the Storage page, locate the Storage Bucket field.
          3. Copy the Storage Bucket URL to your clipboard.
             1. x
          4. Replace copied Storage Bucket URL from firebase console with existing storageBucket .
             1. x
       8. Update IosBundleId for IOS
          1. Go to the ios/Runner/GoogleService-Info.plist file.
             1. x
          2. Copy the BUNDLE ID to your clipboard.
          3. Replace copied BUNDLE ID with existing iosBundleId.
             1. x
23. Update firebase.json file
    1. Go to the Firebase Console and log in using the Google account associated with your Firebase project.
    2. Select your Firebase project from the dashboard.
    3. Navigate to Project Settings:
       1. Click the Settings (gear icon) in the left-hand menu.
       2. Select Project Settings from the dropdown.
    4. Update appId value and android value :
       1. Under the Your Apps section, locate the Android App.
       2. Click on your Android App to view its details.
       3. Locate the App ID field under the app configuration details.
          1. x
       4. Copy the App ID to your clipboard.
       5. Replace copied App ID from firebase console with existing appid and android.
          1. x
    5. Update projectId value :
       1. Under the General tab, locate the Project ID field.
          1. x
       2. Copy the Project ID to your clipboard.
       3. Replace copied Project ID from firebase console with existing projectId
          1. x
    6. Update ios value:
       1. Under the Your Apps section, locate the iOS App.
       2. Click on your iOS App to view its details
       3. Locate the App ID field under the app configuration details.Copy the App ID to your clipboard.
          1. x
       4. Copy the App ID to your clipboard.
       5. Replace copied App ID from firebase console with existing ios.
          1. x

23. Collection name : configs

    Follow these steps to create config collection in your firebase project

    1. Open Firebase Console
       1. Go to the Firebase Project.
       2. Select Your Project
    2. Navigate to Firebase Database
       1. In the left hand menu , click on build
       2. Select Firebase Database
       3. Click on Start Collection button
       4. 1. x
       5. After this you see a popup window like this in this popup enter collection ID
       6. must enter collection ID same as Screenshot.Collection ID : configs
       7. Collection ID : configs
       8. 1. x
       9. After enter collection ID click on next button.
       10. After that opens a popup
       11. 1. x
       12. In this popup click on Auto ID button to get Document ID.
       13. After this enter field name and select its type same as below image
       14. 1. x
       15. Now click on Add Field Button
       16. Click on save button
       17. 1. x
       18. After that opens a add field popup
       19. 1. x
       20. Must Enter Field name as language and select its type as array make sure enter same name and its type same as above image.
       21. After that enter first value as English and make sure its selected type is string. If you want more value like English so click on Add Field button after that you see a new row with type and value make sure its selected type is string if you select other type so does not work as expected.
       22. click on save button.
       23. After that add a new filed in collection click on add new field button same as below image.
       24. 1. x
       25. After that opens a add field popup.
       26. 1. x
       27. Must Enter Field name as tone and select its type as array make sure enter same name and its type same as above image.
       28. After that enter first value as Professional and make sure its selected type is string. If you want more value like Professional so click on Add Field button after that you see a new row with type and value make sure its selected type is string if you select other type so does not work as expected.
       29. click on save button.
       30. After that, the configs collection is created with the proper data, and it appears as shown in the image below
       31. 1. x
       32. After that Add more values in language and tone field.
       33. To Add more values in language field Hover over the field name (language) – you will see a plus(add) icon and a trash (delete) icon appear
       34. 1. x
       35. click on add icon.
       36. 1. x
       37. Enter value like this after that click on add button.
       38. Add at least these values in language field one by one same as above image.
           Hindi, Spanish, Mandarin, French, Russian, Portuguese, Bengali, Japanese, Indonesian, Urdu, Turkish, German, Gujarati
       39. After adding all values in language field step by step language field looks likes below image.
       40. 1. x
       41. To Add more values in tone field Hover over the field name (tone) – you will see a plus(add) icon and a trash (delete) icon appear
       42. 1. x
       43. click on add icon.
       44. 1. x
       45. Enter value like this after that click on add button.
       46. Add at least these values in tone field one by one same as above image.
           Informal, Optimistic, Pessimistic, Joyful, Sad, Sincere, Hypocritical, Fearful, Hopeful, Serious, Funny, Bold, Excited
       47. After adding all values step by step, the tone field appears as shown in the image below
       48. 1. x

1. Link Your Firebase Project

   Before deploying Cloud Functions, ensure that your Firebase project is linked to your local development environment.

   1. Open Android Studio Terminal:
      1. Navigate to View > Tool Windows > Terminal to open the terminal inside Android Studio.
      2. Ensure that you are in the flutter project directory.
   2. Link Firebase Project: Run the following command to link your Firebase project to your local environment:
      1. firebase use –add
         1. x
      2. This command will prompt you to choose your Firebase project.
      3. Select your project from the list.
      4. You can assign an alias (e.g., default or prod).
   3. Verify the Selected Project: Confirm the active project by running this command in terminal :
      1. firebase projects:list
      2. The selected Firebase project will be marked with a checkmark.
2. Install Dependencies

   Ensure that all the necessary dependencies for Firebase Functions are installed.

   1. Navigate to functions Directory: In the terminal, navigate to the function directory inside your project:
      1. cd function
   2. Install Dependencies: Run the following command to install dependencies:
      1. npm install
3. Deploy Firebase Functions

   After the project is linked and dependencies are installed, you can deploy the Cloud Functions to Firebase.

   1. Deploy Functions: Run the following command from the root of your Flutter project:
      1. firebase deploy --only functions
         1. x
      2. This command deploys the functions found in the function directory to your Firebase project.
      3. Wait for the deployment process to complete. The terminal will provide the URL of HTTP-triggered functions and any relevant deployment information.
   2. Monitor Deployment Logs:
      1. Firebase CLI will display logs and progress during the deployment.
      2. If any errors occur, they will be displayed in the terminal for debugging.
4. Test Deployed Functions

   Once the functions are deployed, you can test them using the following steps:

   1. View Functions in Firebase Console:
      1. Go to the Firebase Console for your project.
      2. Navigate to Build > Functions to view the list of deployed functions.
   1. Test HTTP-Triggered Functions:
      1. Copy the provided function URL from the terminal.
      2. Open the URL in your browser or use a tool like Postman to test it.

1. Link Your Firebase Project

   Before deploying Firestore Index, ensure that your Firebase project is linked to your local development environment.

   1. Open Android Studio Terminal
      1. Navigate to View > Tool Windows > Terminal to open the terminal inside Android Studio.
      2. Ensure that you are in the flutter project directory.
   2. Link Firebase Project
      1. Run the following command to link your Firebase project to your local environment:
         1. firebase use –add
            1. x
      2. This command will prompt you to choose your Firebase project.
      3. Select your project from the list.
         1. Select your project from the list.
   3. Verify the Selected Project:
      1. Confirm the active project by running this command in terminal : firebase projects:list
      2. The selected Firebase project will be marked with a checkmark.
2. Initialize Firestore

   If Firestore is not already initialized in your Firebase project, follow these steps:

   1. Run the Firebase initialization command: firebase init firestore
      1. x
      2. During the initialization, respond to the prompts as follows:
         1. Prompt 1:
            1. "You are initializing within an existing Firebase project directory. Are you ready to proceed?"
               1. Select: Yes
            1. x
         2. Prompt 2:
            1. "What file should be used for Firestore Rules?"
               1. Default: firestore.rules
                  1. x
         3. Prompt 3:
            1. "File firestore.rules already exists. Do you want to overwrite it with the Firestore Rules from the Firebase Console?"
               1. Select: No
         4. Prompt 4:
            1. "What file should be used for Firestore indexes?"
               1. Default: firestore.indexes.json
            1. x
   2. Deploy Firebase Index
      1. Deploy Indexes: Run the following command from the root of your Flutter project:
         1. firebase deploy --only firestore:indexes
         1. x
      2. This command uploads your local firestore.indexes.json file to Firestore.
      3. Wait for the deployment process to complete. The terminal will provide the URL of project console and any relevant deployment information.
      4. Monitor Deployment Logs:
         1. Firebase CLI will display logs and progress during the deployment.
         2. If any errors occur, they will be displayed in the terminal for debugging.
   3. Test Deployed Firestore Indexes

      Once the Firestore indexes are deployed, you can test and verify them using the following steps:

      1. View Indexes in Firebase Console
         1. Go to the Firebase Console for your project: https://console.firebase.google.com/.
         2. Navigate to:
            1. Build > Firestore Database > Indexes.
            2. This will display the list of all deployed indexes.li>
      1. x

1. Log in to the Admin App:
   1. Open the Admin App on your device.
   2. Enter your login credentials (e.g., email and password) and tap Log In.
2. Navigate to the Account Section:
   1. Once logged in, locate the Bottom Navigation Bar at the bottom of the screen.
   2. Tap on the Account tab to access the account-related settings.
      1. 
3. Open API Configuration:
   1. Inside the Account section, scroll through the options and locate API Config.
   2. Tap on API Config to view and manage the API settings
      1. x
4. Enter or Update API Token:
   1. If no API key has been entered previously, you will see a field to enter the API Token.
   2. Enter a valid API token provided by OpenAI to enable the AI-powered features in the application.
      1. x
5. Update API Token (if applicable):
   1. If an API token is already entered but needs to be changed.
   2. Replace the existing token with the new one. .
6. Verify API Token:
   1. Ensure that the token you provide is accurate and corresponds to the OpenAI account associated with your application.
   2. Incorrect or invalid tokens may result in the AI-powered features not functioning as expected

1. This section allows you to configure the API-related settings, such as entering the OpenAI API authentication token, enabling AI-powered features in the user application.

1. Log in to the Admin App:
   1. Open the Admin App on your device.
   2. Enter your login credentials (e.g., email and password) and tap Log In.
2. Navigate to the Account Section:
   1. Once logged in, locate the Bottom Navigation Bar at the bottom of the screen.
   2. Tap on the Account tab to access the account-related settings.
3. Open Payment Settings:
   1. Inside the Account section, scroll through the options and tap on Payment Settings.
   2. This will take you to a screen displaying a list of all integrated payment gateways.
      1. x
4. Open Payment Settings: Manage Payment Gateways:
   1. In the Payment Settings screen, you will see a list of all available payment gateways.
   2. Each payment gateway will have the following options:
      1. Toggle for Activate/Deactivate:
         1. A toggle switch will be displayed next to each payment gateway
         2. You can activate the gateway by turning the toggle On, which will enable the gateway for use.
         3. You can deactivate the gateway by turning the toggle Off, which will disable the gateway for transactions.
      2. View Details Icon Button:
         1. Next to each gateway, there will be an icon button (e.g., an eye icon or settings icon).
         2. Tap the View Details icon to navigate to a detailed configuration screen where you can manage credentials and gateway settings.
            1. x
5. Navigate to Payment Gateway Details Screen:
   1. After tapping the View Details icon, you will be redirected to a screen where you can:
      1. Toggle for Activate/Deactivate:
         1. A toggle switch will be available on this screen as well, allowing you to activate or deactivate the payment gateway.
         2. You can enable or disable the gateway directly from this screen by turning the toggle On or Off.
      2. Update/Add Credentials:
         1. On this screen, you can directly input or modify the API credentials (such as API keys, secret keys, account details, etc.) for the payment gateway.
         2. After entering the credentials, tap add or update button to update the payment gateway configuration.
            1. x
6. Navigate to Payment Gateway Details Screen: Verify Changes:
   1. Return to the Payment Settings screen to verify that the updated credentials and configuration are reflected properly. .
   2. Ensure that the gateway toggle switch is in the correct position (active or inactive) based on your changes. .

// primary color for light and dark both theme
static const Color primaryColor = Color(0xff575EBE); // Replace with your preferred color

app_constants.dart

// App Font Family
const String fontFamilyName = 'Roboto'; // Replace 'Roboto' with your desired font family name Add the Font to Your App (If Needed)

1. x

1. If the font family you chose is not a default font, ensure you have added it to your project:

4. Update the pubspec.yaml file to include the font:

 flutter:
  fonts:
  - family :YourFontName
       fonts:
         - asset:assets/fonts/YourFontName-Regular.ttf

1. x

5. Apply the Font in Your App
   1. Use the updated font family in your app’s ThemeData:
6. Save and Rebuild
   1. Save the file and restart your app to apply the new font family.

// Onboarding titles and descriptions
static const String onboardingTitleOne = "YOUR_PREFERRED_TITLE_ONE";
static const String onboardingDesOne = "YOUR_PREFERRED_DESCRIPTION_ONE";

static const String onboardingTitleTwo = "YOUR_PREFERRED_TITLE_TWO";
static const String onboardingDesTwo = "YOUR_PREFERRED_DESCRIPTION_TWO.";

static const String onboardingTitleThree = "YOUR_PREFERRED_TITLE_THREE";
static const String onboardingDesThree = "YOUR_PREFERRED_DESCRIPTION_THREE";

1. x

1. Sign Up as a User in the App
   1. Open the Flutter app and navigate to the Sign-Up screen.
   2. Enter the required details (email, password, etc.).
   3. Submit the form to create an account.
   4. Upon successful registration, Firebase Authentication will store the user credentials.
2. Update User Role in Firebase Console
   1. Go to Firebase Console.
   2. Select your Firebase project.
   3. Navigate to Firestore Database from the left sidebar.
   4. Click on the users Collection.
   5. Find the newly registered user by searching for their email.
      1. x
   6. Locate the field named userType.
   7. Change the value of userType from user to admin.
      1. x
   8. Click Save Changes.
3. Log in as Admin in the App
   1. Open the app and go to the Login screen.
   2. Enter the same email and password used during sign-up.
   3. Upon successful login, the app will fetch user details from Firestore.
   4. The app will check if userType is admin.
   5. If userType is admin, the user is redirected to the Admin Dashboard.
   6. If userType is still user, they will remain in the regular user interface.