EN PT

User Manual

Frontend Application - Comprehensive Guide

Version 1.0 | Last Updated: December 03, 2025

Quick Navigation

Introduction Getting Started Profile Actions Performance Catalogue News Legal

1. Introduction

Overview

This comprehensive user manual provides detailed guidance for navigating and using all frontend sections of the Neo Laravel Platform. The platform was designed as a complete engagement and rewards management system that allows users to manage their accounts, earn and redeem points, track performance, participate in games and activities, and access various content and services.

Main Features

User Account Management Full control over personal data, addresses, balance tracking and account settings
Rewards Catalog Browse and redeem products using earned points with advanced search and filters
Performance Tracking Monitor KPIs and personal achievements
Gamification Interactive games including Wheel of Fortune and Slot Machine
Communication Integrated messaging system and notification center
Content Management Access news, rules, legal documents and information pages
E-Learning and Surveys Participate in surveys and educational modules
Actions and Campaigns Participate in special actions to earn additional points

System Requirements

Recommended Browsers:
  • Google Chrome (latest version)
  • Mozilla Firefox (latest version)
  • Microsoft Edge (latest version)
  • Apple Safari (latest version)
Mobile Access:

The platform is fully responsive and optimized for mobile devices, providing a seamless experience across all screen sizes.

2. Getting Started

Accessing the Application

  1. Open your web browser and navigate to the application URL provided by your administrator
  2. You will be automatically redirected to the login page if you are not yet authenticated
  3. Enter your credentials (username/email and password) to access the platform
  4. After successful login, you will be directed to your main dashboard
login page showing the form with username/email and password fields

3. Authentication and Account Management

Login

Purpose: Access your account securely using your credentials.

How to Login

  1. Navigate to the login page (you will be automatically redirected if not authenticated)
  2. Enter your username or email address in the username field
  3. Enter your password in the password field (passwords are case-sensitive)
  4. Click the "Login" button or press Enter
  5. If your credentials are correct, you will be redirected to your main dashboard
Login page
Security Tips:
  • Never share your password with anyone
  • Use a strong password with a combination of letters, numbers and special characters
  • Logout when using shared computers
  • Change your password regularly

Password Recovery

Purpose: Reset your password if you have forgotten it or need to change it for security reasons.

Password Reset by Email

  1. On the login page, click the "Forgot Password" link
  2. Enter the email address associated with your account
  3. Click "Submit" or "Send Reset Link"
  4. Check your email inbox (and spam folder) for a password reset email
  5. Click the reset link in the email (links typically expire after a defined period)
  6. Enter your new password twice for confirmation
  7. Click "Reset Password" to complete the process
  8. You can now login with your new password
Password recovery form

Password Reset by SMS

Some configurations support password reset by SMS. If available:

  1. Click "Forgot Password" on the login page
  2. Select the SMS reset option if available
  3. Enter your phone number
  4. Receive a verification code by SMS
  5. Enter the code and create a new password

First Access and Account Activation

Purpose: Complete your profile setup when accessing the platform for the first time or when your account requires activation.

If this is your first access to the platform, you may be guided through an activation process. This process typically consists of five steps:

Activation Process Overview:
  • Step 1: Initial account verification and welcome
  • Step 2: Filling in personal information (name, email, phone, etc.)
  • Step 3: Additional profile details and preferences
  • Step 5: Final confirmation and account activation

Activation Steps

Step 1: Initial Verification

Verify your account and review the welcome information. You may need to accept terms and conditions.

activationstep1
Step 2: Personal Information

Complete your personal data:

  • Full name
  • Email address
  • Phone number (with country code)
  • Tax identification number (TIN)
  • Date of birth (if required)
Important: Make sure all information is correct, as it may be used for order processing and account verification.
Step 2 - Personal information
Step 3: Additional Details

Provide any additional profile information required by your organization.

Activation step 3 - Additional details
Step 5: Confirmation

Review all information and confirm your account activation. You will then be redirected to the main dashboard.

Passo 5 - Confirmation

SSO Login (Single Sign-On)

If your organization uses Single Sign-On (SSO), you can login using your organization credentials:

  1. Click the SSO login option if available
  2. You will be redirected to your organization login page
  3. Enter your organizational credentials
  4. You will be automatically authenticated on the platform

Logout

To logout from your account securely:

  1. Click the "Profile" menu in the navigation
  2. Select "Logout" from the dropdown menu
  3. You will be logged out and redirected to the login page
Security Reminder: Always logout when using shared or public computers to protect your account.

4. Home Page

Purpose: After successful login or account activation, you will be redirected to the home page, which serves as the main entry point for the platform.

Home Page Overview

The home page provides access to:

  • Navigation Menu: Access all main sections of the platform
  • Quick Links: Direct access to frequently used features
  • Featured Products: Featured products from the catalog
  • News and Updates: Latest announcements and information
  • Performance Overview: Quick view of your point balance and recent activity
  • Recent Activity: Summary of your latest actions, points earned and order updates
Home page overview

Home Page Features

  1. Navigate through the main menu to access different sections
  2. View featured products and promotions
  3. Check the latest news and announcements
  4. Quick access to your profile, balance and orders
Note: The home page layout may vary depending on your organization configuration. Some mentioned features may not be available in all installations.
Quick Actions Shortcuts to frequently used features such as catalog, games and messages
Recent Activity Summary of your latest actions, points earned and order updates
Notifications Important announcements and system notifications

Performance Chart

The performance chart displays your activity and points earned over time.

5. Profile Section

Purpose: The Profile section is your central location for managing personal information, account settings, addresses, balance, orders and preferences.

Personal Data

Purpose: View and update your personal information, change password, manage communication preferences and account deletion options.

View Personal Data

  1. Navigate to Profile > Personal Data
  2. View your current personal information displayed in the form
  3. Note: The username is usually not editable and appears as disabled
Personal data page showing all fields including password change and account deletion

Update Personal Information

You can update the following information:

  • Name: Your full name
  • Email: Your email address (used for notifications and password recovery)
  • Phone Number: Your mobile/phone number with country code
  • Tax Identification Number (TIN): Your tax identification number
  • Newsletter Subscription: Toggle to receive newsletters
  1. Navigate to Profile > Personal Data
  2. Edit the fields you want to change
  3. For the phone number, select the country code from the dropdown menu
  4. Enter your phone number (validation rules apply based on country)
  5. Toggle newsletter subscription if desired
  6. Click "Save" to update your information
  7. A success message will confirm your changes
Phone Number Validation:

The system validates phone numbers based on the selected country code. Make sure your phone number:

  • Has the correct number of digits for your country
  • Starts with a valid prefix for your country
  • Contains only numeric characters

Change Password

To change your password:

  1. Scroll to the "Change Password" section on the Personal Data page
  2. Enter your current password in the "Old Password" field
  3. Enter your new password in the "New Password" field
  4. Re-enter your new password in the "Repeat Password" field for confirmation
  5. Click "Save" to update your password
Password Requirements:
  • Minimum of 8 characters
  • Must contain uppercase and lowercase letters
  • Must contain at least one number
  • Maximum of 50 characters

Account Deletion

⚠️ WARNING: Account deletion is permanent and irreversible. Please read all consequences carefully before proceeding.

If you need to delete your account:

  1. Scroll to the "Delete Account" section on the Personal Data page
  2. Read all important notes about account deletion
  3. Understand that you will lose:
    • All earned points
    • Ability to claim warranty for requested rewards
    • Access to transaction information
    • Ability to receive ongoing orders
  4. Click the "Delete Account" button
  5. Confirm deletion when prompted
  6. Your account will be permanently deleted

Address Management

Purpose: Manage delivery addresses for orders and shipments. You can add multiple addresses and set a default address.

Manage Addresses

On the Addresses page, you can:

  • View all your saved addresses
  • Add new delivery addresses
  • Edit existing addresses
  • Set a default address for orders
  • Delete addresses (if not in use)

View Addresses

  1. Navigate to Profile > Address
  2. View your list of saved addresses
  3. See which address is set as default (if any)

Add a New Address

  1. Navigate to Profile > Address
  2. Click the "Add New Address" or "Create" button
  3. Fill in the address form with:
    • Address
    • City
    • Postal code
    • Country
    • Additional address details (if applicable)
  4. Check "Set as default" if you want this to be your main address
  5. Click "Save" or "Create Address"
  6. Your new address will be added to your list
Address management page showing list, add, edit and delete options

Edit an Address

  1. Navigate to Profile > Address
  2. Find the address you want to edit
  3. Click the "Edit" button next to the address
  4. Modify the necessary fields
  5. Click "Save" to apply the changes

Delete an Address

  1. Navigate to Profile > Address
  2. Find the address you want to delete
  3. Click the "Delete" button next to the address
  4. Confirm deletion
  5. The address will be removed from your list
Note: You cannot delete an address that is currently being used for an active order. Wait until the order is completed or cancelled.

Balance and Statements

Purpose: View your point balance, transaction history, point breakdown by category and detailed point information.

View Your Balance

  1. Navigate to Profile > Balance
  2. View your current total balance displayed at the top of the page
  3. View the breakdown of:
    • Available points
    • Pending points (if any)
    • Points by category or origin
Balance page showing total balance and breakdown

Transaction History

The balance page displays your transaction history:

  1. Scroll down on the Balance page to view transaction history
  2. View a chronological list of all point transactions
  3. Each transaction shows:
    • Date and time
    • Transaction type (earnings, redeemed, etc.)
    • Point amount (positive for earnings, negative for redeemed)
    • Description or origin
    • Related order or activity (if applicable)
  4. Use pagination to navigate through older transactions
  5. If available, use filters to view specific periods or transaction types
Transaction history table

Balance Display in Header

Your current balance is also displayed in the header of each page:

  • Shows your total available points
  • Clicking it takes you directly to the Balance page
  • Updates automatically when points are earned or redeemed

Messages

Purpose: Communicate with administrators, receive important notifications and manage your message inbox.

Access Messages

  1. Click the envelope icon in the header (shows unread count)
  2. Or navigate to Profile > Messages
  3. Access your message inbox
Message inbox

View Your Inbox

  1. Navigate to Profile > Messages
  2. View your message list showing subject, sender, date and unread indicators
  3. Click a message to read it
  4. Use pagination to navigate through older messages

Read Messages

  1. Click a message from your inbox
  2. View the full message content
  3. The message is automatically marked as read
  4. View any attachments if present
  5. Reply to the message if replies are enabled

Orders

Purpose: View complete order history, order details and track order status.

View Order List

  1. Navigate to Profile > Orders
  2. View a list of all your orders, usually sorted by most recent first
  3. Each order entry shows:
    • Order number
    • Order date
    • Order status (Pending, Processing, Shipped, Delivered, Cancelled)
    • Total points used
    • Number of items
  4. Use pagination to view older orders
Order list page

View Order Details

  1. Click an order from the order list
  2. View detailed information including:
    • Order number and date
    • List of ordered products
    • Quantity and points for each item
    • Delivery address
    • Order status and timeline
    • Tracking information (if available)
  3. Download order confirmation or invoice if available
Order details page

Track Order

Purpose: Track delivery status and location of your orders in real time.

Track an Order

  1. Navigate to Profile > Orders
  2. Click the order you want to track
  3. Click the "Track Order" button or navigate to the tracking page
  4. View current status and delivery timeline
  5. View tracking updates as your order progresses
Order tracking page with status timeline

Order Status Types

Orders can have the following statuses:

  • Pending: Order received, awaiting processing
  • Processing: Order is being prepared
  • Shipped: Order has been dispatched
  • In Transit: Order is on the way
  • Delivered: Order has been delivered
  • Cancelled: Order has been cancelled

Electronic Vouchers

Purpose: View and manage your electronic vouchers, including voucher codes and redemption instructions.

View Vouchers

  1. Navigate to Profile > Electronic Vouchers
  2. View your list of available vouchers
  3. View voucher details including:
    • Voucher name/description
    • Value or type
    • Expiration date
    • Status (Active, Used, Expired)
Voucher list

Access Voucher Codes

  1. Click a voucher to view details
  2. View the voucher code (may be hidden until clicked)
  3. Copy the voucher code for redemption
  4. Follow the provided redemption instructions
  5. Note the expiration date and terms of use
Voucher code display

Favorites

Purpose: View and manage your saved favorite products from the catalog.

View Favorites

  1. Navigate to Profile > Favorites
  2. View all your saved favorite products
  3. View product images, names and point requirements
  4. Products are displayed in grid or list format
Favorites page

Manage Favorites

On the favorites page, you can:

  • Click a product to view details
  • Add products directly to cart
  • Remove items from favorites
  • Filter or sort favorites (if available)

Add Products to Favorites

To add products to favorites:

  1. Browse the catalog
  2. Click a product to view details
  3. Click the heart icon or the "Add to Favorites" button
  4. The product will be added to your favorites list

12. Actions

Purpose: Participate in special actions, campaigns and activities to earn additional points, complete challenges and engage with program initiatives.
Actions menu
Action details

8. Performance & Rankings

Performance Overview

Purpose: Monitor your performance metrics, track KPIs and analyze your achievements.

Access Performance

  1. Click "Performance" in the main navigation menu
  2. View the dropdown menu with performance options
  3. Select the desired performance section

Personal Performance (KPI)

Purpose: View your Key Performance Indicators (KPIs), track performance metrics, monitor achievement levels and analyze your progress.

View KPIs

  1. Navigate to Performance > Personal Performance
  2. View your KPI dashboard
  3. View individual metrics displayed as:
    • Numbers and percentages
    • Progress bars
    • Charts and tables
    • Comparison with goals
  4. Review your progress over time
  5. Identify areas for improvement
KPI dashboard

KPI Metrics

Common KPI metrics may include:

  • Achievement of production goals
  • Points earned vs. goals
  • Activity completion rates
  • Engagement metrics
  • Ranking positions
  • Goal completion percentages
Note: Some performance features may be organization-specific. Not all features are available in all installations.

6. Catalogue & Shopping

Purpose: Browse available products and rewards that can be redeemed using your earned points.
Main catalog
Filters and search

Checkout Process

Purpose: Complete your order and redeem products using your points.

Step 1: Address Selection

  1. From your cart, click "Checkout" or "Proceed to Checkout"
  2. Review selected products
  3. Select a delivery address from your saved addresses
  4. Or add a new address if necessary
  5. Verify that address details are correct
  6. Click "Continue" or "Next" to proceed
address selection step

Step 2: Order Preview

  1. Review the complete summary of your order
  2. Verify products and quantities
  3. Verify total points required
  4. Confirm delivery address
  5. Review any additional order details
  6. If everything is correct, click "Confirm Order" or "Place Order"
order preview/confirmation page

Step 3: Order Confirmation

  1. After confirming, view your order confirmation page
  2. Note your order number (keep for reference)
  3. Read the confirmation message
  4. View order tracking information (if available)
  5. Receive email confirmation (if email notifications are enabled)
  6. Points will be deducted from your balance
order confirmation page with order number
After Placing the Order:
  • Your order will be processed by administration
  • You can track your order status in Profile > Orders
  • You will receive updates as your order progresses
  • Contact support if you have questions about your order

11. News & Information

Purpose: Stay updated with the latest news, announcements and important information from your organization.

Access News

  1. Navigate to Info > News
  2. Or click news items from the home page
  3. View the list of news articles
News section

View News Articles

  1. Browse the list of news articles
  2. View article titles, dates and previews
  3. Click an article to read the full content
  4. View article details including:
    • Full article content
    • Publication date
    • Author information (if available)
    • Related images
    • Categories or tags
  5. Use pagination to view older articles
  6. Navigate back to the news list when finished
News article detail page

News Features

  • Chronological listing of articles
  • Article previews and summaries
  • Full article content with formatting
  • Image gallery
  • Search and filters
  • Article sharing
↑
Aceitar