Things You Must Have:

These are prerequisites for Badges.

• Lernen: 2.2.0
• Ensure the Laravel Scheduler is properly configured and running on your server to maintain scheduled task execution

Download & Installation

Follow these steps to install the StarUp add-on in your Lernen project:

• Step 1: Download the Package

  When downloading the zip package file from CodeCanyon, you'll have all the files you need inside. The zip package contains the following files:

  • Starup.zip contains the StarUp Add-on
  • documentation.zip folder (It contains documentation for the add-on)

• Step 2: Extract the Package
  • Extract the downloaded zip file i.e. Starup.zip
• Step 3: Install StarUp
  • Goto Admin > Manage Addons and click on Add new.
  • Choose the Starup.zip file and click on Install.
• Alternatively, Manually Installation

  If you prefer to manually install the StarUp add-on, follow these steps:

  • Extract the downloaded zip file i.e. Starup.zip in Modules/ directory
  • After uploading you need to execute the following commands in the website root directory through CLI
    • Execute this – php artisan module:enable Starup
    • Execute this – php artisan module:migrate Starup
    • Execute this – php artisan module:publish Starup
    • Execute this – php artisan module:seeder Starup

Admin Settings

• Badges Settings Overview:
  • Badge Assignment Frequency:In the Badges Settings section, you can set how often badges should be assigned to users. Options include Every minute,Every 30 minutes, Daily, Weekly, or Monthly.
  • Save Changes: After customizing the badge settings, click the Save changes button to apply the updates.
  • Reset Options: You can reset specific sections or all settings using the Reset section or Reset all buttons.

• Add Badge Details:
  • Badge Type: Select the type of badge you want to assign. Options may include profile verification badges or other custom badges.
  • Badge Name: Enter the name of the badge in the input field.
  • Badge Description: Provide a description for the badge using the rich text editor. You can format text (e.g., bold, italics) for better presentation.
  • Select Badge Criteria: Choose the criteria for earning the badge. Options may include Profile Complete or Trusted Tutor.
  • Upload Badge Icon You can drag and drop or upload an image (jpg, jpeg, png, gif) with a max size of 5MB for the badge icon.
• Save or Cancel:
  • Once all fields are filled, click "Save changes" to create the badge.
  • If you wish to discard the changes, click "Cancel".

• Update Badge:
  • If you want to edit an existing badge, locate the badge in the list and click on the Edit button next to it.
  • The current badge details will be loaded into the form. Make the necessary changes, such as updating the badge type, name, description, criteria, or icon.
  • For example, you may update the Minimum Rehired Booking Count to adjust the number of times a tutor needs to be rehired to qualify for this badge.
  • After making changes, click "Save changes" to apply the updates.
  • If you want to discard the changes, click "Cancel".
• Save or Cancel:
  • Once all fields are filled, click "Save changes" to update the badge.
  • If you wish to discard the changes, click "Cancel".

• Badges List:
  • The badges list displays all available badges with the following columns:
  • Badge Name: The specific name assigned to each badge, such as "Student Favorite" or "Returning Students".
  • Badge Description: A short explanation of the criteria required to earn the badge, for example, "Rehired by 25 students" or "Profile verified by admin".
  • Badge Type: The category of each badge, e.g., "Rehired Tutor Badges" or "Subject Mastery Badges".
  • Created Date: The date when the badge was created, providing a record of when badges were added.
  • Actions: The available actions for each badge, including:
    • Edit Button: Allows the admin to modify the details of the badge (e.g., name, description, type, or criteria).
    • Delete Button: Allows the admin to remove a badge from the list.
• Adding a New Badge:
  • Click the "Add badge" button at the top right corner to add a new badge.
  • This opens a form where you can enter the badge type, badge name, badge description, criteria, and upload an icon for the badge.
• Editing a Badge:
  • To edit an existing badge, locate the badge in the list and click the Edit button under the "Actions" column.
  • The current badge details will be loaded into a form, allowing you to make changes such as updating the name, type, or criteria.
• Deleting a Badge:
  • Click the Delete button next to the badge you want to remove. This will delete the badge from the list.
• Pagination:
  • Use the pagination controls at the bottom of the badges list to navigate between multiple pages of badges if there are many available.

• Deleting a Badge:
  • Click the Delete button next to the badge you want to remove. This will bring up a confirmation dialog asking, "Are you sure you want to delete this badge?"
  • The dialog has two options:
    • No: Cancels the deletion, and the badge remains unchanged.
    • Yes: Confirms the deletion and removes the badge from the list.

Tutor Detail

• Badges Display on Tutor Profile:
  • Below the tutor's name, there is a section with multiple badges (highlighted in the red box in the provided screenshot).
  • These badges represent different achievements or qualifications that the tutor has earned, helping potential students quickly assess the tutor's skills and reliability.
  • Types of Badges: The badges may include:
    • Popularity Badge: Indicates that the tutor is popular among students, often based on the number of bookings or positive reviews.
    • Experience Badge: Represents milestones such as completing a certain number of sessions or being rehired by students.
    • Verification Badge: Confirms that the tutor's credentials, such as identity or certifications, have been verified by the platform.
    • Achievement Badges: These badges may indicate subject-specific achievements, like proficiency in a subject or recognition for excellent tutoring performance.
  • Significance of Badges:
    • Badges enhance the credibility and trustworthiness of the tutor's profile, making it easier for students to select a tutor based on their qualifications and achievements.
    • Students can use these badges as visual cues to assess whether the tutor matches their learning needs and preferences.

Running the Scheduler

The schedule:run Artisan command evaluates all of your scheduled tasks and determines if they need to run based on the server's current time. You can add this command to your crontab file to run the scheduler at regular intervals.

* * * * * cd /path-to-your-project && php artisan schedule:run >> /dev/null 2>&1