Eska Platform Documentation

The Eska Platform is a comprehensive trading platform that combines traditional trading functionality with innovative gamification features. Built with Laravel 12 and Vue.js 3, it provides a modern, responsive interface for both traders and administrators.

The platform integrates with external broker APIs to provide real-time trading data while offering a unique rewards system that encourages user engagement through points, achievements, and redeemable rewards.

Backend Technologies

• Laravel 12 - PHP framework for robust backend development
• PHP 8.2+ - Modern PHP with enhanced performance and features
• MySQL/SQLite - Database management with migration support
• Laravel Sanctum - API authentication and token management
• Laravel Queue - Background job processing for scalability
• Filament 4 - Admin panel framework for rapid development

Frontend Technologies

• Vue.js 3 - Progressive JavaScript framework with Composition API
• Inertia.js - Modern SPA framework for seamless routing
• Tailwind CSS - Utility-first CSS framework for rapid styling
• DaisyUI - Component library built on Tailwind CSS
• Chart.js - Data visualization and analytics charts
• Vite - Fast build tool and development server

Development Tools

• Composer - PHP dependency management
• NPM - Node.js package management
• Git - Version control and collaboration
• PHPUnit - Unit testing framework
• Laravel Pint - Code style enforcement

Prerequisites

• PHP 8.2 or higher
• Composer (latest version)
• Node.js 18+ and NPM
• MySQL 8.0+ or SQLite
• WAMP/XAMPP (for local development)

Installation Steps

# Clone the repository
git clone [repository-url] eska-platform
cd eska-platform

# Install PHP dependencies
composer install

# Install Node.js dependencies
npm install

# Copy environment file
cp .env.example .env

# Generate application key
php artisan key:generate

# Run database migrations
php artisan migrate

# Seed the database
php artisan db:seed

# Build frontend assets
npm run build

# Start the development server
php artisan serve
npm run dev

Environment Configuration

Configure your .env file with the following essential settings:

APP_NAME="Eska Platform"
APP_ENV=local
APP_DEBUG=true
APP_URL=http://localhost:8000

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=eska_platform
DB_USERNAME=root
DB_PASSWORD=

BROKER_API_URL=your_broker_api_url
BROKER_API_KEY=your_broker_api_key
BROKER_API_SECRET=your_broker_api_secret

SESSION_DRIVER=database
SESSION_LIFETIME=1440
SANCTUM_STATEFUL_DOMAINS=localhost,localhost:3000,localhost:5173

The Dashboard is your central hub for monitoring your trading performance, points balance, and platform activity. It provides a comprehensive overview of your account status and recent activities.

Key Features

• Points Balance - View your current points and recent point transactions
• Trading Overview - Monitor your trading performance and portfolio status
• Recent Activity - Track your latest quests, achievements, and rewards
• Quick Actions - Access frequently used features like Spin Wheel and Quests
• Performance Metrics - View your trading statistics and progress

📖 View Complete Dashboard Documentation

Quests are gamified challenges that reward you with points for completing various trading and platform activities. They help you learn trading strategies while earning rewards.

Quest Types

• Daily Quests - Simple tasks that reset every day
• Weekly Quests - More complex challenges with higher rewards
• Special Quests - Limited-time events and seasonal challenges
• Trading Quests - Tasks related to specific trading activities
• Learning Quests - Educational challenges to improve your trading knowledge

📖 View Complete Quests Documentation

The Spin Wheel is an exciting feature that allows you to win rewards by spinning a virtual wheel. Use your points to spin and potentially win valuable prizes.

How It Works

• Cooldown System - Strategic timing system to prevent abuse and maintain engagement
• Prize Categories - Win points, bonuses, mystery rewards, or special items
• Probability System - Weighted distribution for balanced reward allocation
• Canvas Animation - Smooth, interactive spinning wheel with visual feedback
• Instant Rewards - Prizes are credited immediately to your account

🎯 View Complete Spin Wheel Documentation

Trade Sense is an AI-powered educational game that tests your trading knowledge through real-time questions generated by advanced AI. Earn points for correct answers and improve your trading expertise.

Key Features

• AI-Generated Questions - Advanced AI creates unique, challenging trading questions
• Time-Limited Challenges - 60-second sessions to answer as many questions as possible
• Point Rewards - Earn points for each correct answer
• Educational Explanations - Detailed explanations for each answer
• Daily Limits - 10 sessions per day to ensure fair play
• Performance Analytics - Track accuracy, speed, and improvement

The Rewards catalog offers a variety of redemption options for your earned points, including cash rewards, merchandise, vouchers, and special bonuses.

Reward Categories

• Cash Rewards - Direct cash redemptions to your account
• Merchandise - Physical items and branded merchandise
• Vouchers - Gift cards and discount vouchers
• Trading Bonuses - Enhanced trading features and benefits
• Special Access - Exclusive features and premium content

Compete with other traders on the leaderboard and see how you rank based on various metrics including points, trading performance, and quest completion.

Ranking Categories

• Points Leaderboard - Ranked by total points earned
• Trading Performance - Based on trading success and profitability
• Quest Completion - Ranked by quests completed and success rate
• Monthly Rankings - Reset monthly for fresh competition
• Achievement Points - Based on special achievements unlocked

Track all your earnings and point transactions in detail. The Earnings Log provides comprehensive records of how you've earned and spent your points.

Transaction Types

• Quest Rewards - Points earned from completing quests
• Trading Bonuses - Points from successful trades
• Spin Wheel Winnings - Rewards from spin wheel activities
• Referral Bonuses - Points from successful referrals
• Redemption Records - Points spent on rewards and redemptions

Monitor and manage all your trading activities in one place. View your trade history, current positions, and trading performance metrics.

Trade Management

• Trade History - Complete record of all your trades
• Current Positions - Monitor your active trading positions
• Performance Analytics - Detailed analysis of your trading results
• Profit/Loss Tracking - Monitor your trading profitability
• Trade Export - Download your trading data for external analysis

Unlock special achievements by reaching milestones in your trading journey. Achievements provide recognition for your progress and unlock special rewards.

Achievement Categories

• Trading Achievements - Milestones in trading performance
• Quest Achievements - Recognition for quest completion
• Social Achievements - Referral and community participation
• Learning Achievements - Educational milestones and skill development
• Special Achievements - Unique accomplishments and rare feats

Manage your personal information, preferences, and account settings. Customize your profile to reflect your trading style and preferences.

Profile Features

• Personal Information - Update your name, email, and contact details
• Avatar Management - Upload and customize your profile picture
• Privacy Settings - Control what information is visible to others
• Notification Preferences - Manage how you receive platform notifications
• Account Security - Update passwords and security settings

Get help when you need it. Access our comprehensive FAQ, submit support tickets, and find answers to common questions about the platform.

Support Features

• FAQ Section - Answers to frequently asked questions
• Support Tickets - Submit and track support requests
• Live Chat - Get immediate help from our support team
• Documentation - Comprehensive guides and tutorials
• Community Forum - Connect with other traders and share experiences