Quizix Documentation
website·Indexed 29 days ago
https://quiz-doc.vercel.appComprehensive guides for installing and configuring Quizix, including VPS and Windows setup, mobile app API connection, and quiz management. Includes detailed integration steps for payment gateways such as Stripe, Braintree, Square, Paystack, Skrill, Flutterwave, Vrpay, Payu, Cryptomus, Aamarpay, and Toyyibpay, as well as system settings for KYC, GDPR, and notifications.
What's inside Quizix
- The Contests Category Management section allows administrators to organize contest topics. Categories are displayed in a table containing the category Title, an Image for visual identification, and an Action menu for modifications.
Understand Next.js Static Export for cPanel hosting
Static export converts a Next.js project into pure HTML, CSS, and JavaScript files. This allows the site to be served as a plain HTML site on platforms like cPanel or shared hosting without requiring a Node.js runtime.
Key Constraints:
- Does not support server-side rendering (SSR), API routes, or middleware.
- All data is generated at build time. Changes made in the admin panel (Settings, Themes, SEO, PWA) will not appear until the project is rebuilt and redeployed.
Manage and verify contest winners
Administrators can use the Contest Winners Management section to view and verify prize distributions. The Winners page provides a tabular list of all users who have won a contest, allowing admins to filter results by
contest_id.Each entry in the winners table contains the following data:
- Contest: The title of the contest (supports multi-language translation).
- User: The winner's full name, avatar, and username.
- Prize Name: The specific type or name of the prize (e.g., 'Cash Prize').
- Prize Coins: The monetary value or coin amount awarded.
- Rank: The user's final position in the contest.
- Action: A menu to access more detailed information about the specific winner.
Configure GoCardless business profile and payouts
Before processing live payments, the following account configurations are required in the GoCardless Dashboard:
- Business Profile: Navigate to
Settings > About Your Businessto enter legal name, address, phone, and website URL. - Verification: Navigate to
Settings > Verificationand submit required business registration documents (e.g., Companies House for UK). Approval typically takes 1-2 business days. - Settlement Bank: Navigate to
Settings > Payoutsto add bank details (e.g., IBAN for SEPA or sort code/account number for UK) for receiving funds.
- Business Profile: Navigate to
Understand deployment constraints for Quizix on cPanel
Deploying Quizix on cPanel is not recommended due to its two-part architecture: an Admin API built with Laravel and a Client built with Next.js. Key constraints include:
- Node.js Support: Next.js requires a Node.js runtime, which is often missing or limited on cPanel servers (unless using CloudLinux with Node.js support).
- Performance: Shared hosting environments in cPanel may limit CPU and memory, leading to slow build times or crashes.
Recommended Alternatives:
- Use a VPS or cloud provider (e.g., DigitalOcean, AWS, Linode, Vultr) for full environment control.
- Deploy the Laravel Admin API on cPanel and the Next.js Client on Vercel.
Understand Quizix Standalone deployment mode
Standalone mode is a full server-side Next.js build where the application runs as a Node.js server. This mode supports server-side rendering (SSR), API routes, middleware, and dynamic rendering.
Key Advantages:
- Admin panel changes (settings, SEO, feature toggles) are applied instantly without requiring a frontend rebuild.
- Supports dynamic content and authentication-based rendering via on-request page rendering.
Requirements:
- Requires a VPS, dedicated server, or a platform supporting Node.js.
- If using cPanel, Node.js must be available and properly configured. Note that the developers generally recommend Vercel, Netlify, AWS, Digital Ocean, or Azure over cPanel for this mode.
Configure the Cryptomus Business Wallet and Merchant Profile
Before accepting payments, you must set up a Business Wallet, which is separate from your Personal Wallet.
- Create Merchant Profile: Navigate to Overview > Business Wallet in the dashboard, click Create Merchant, and enter your business name.
- Merchant Verification: To enable Live Mode, go to Settings > API Integration and submit your website URL and project description. Verification typically takes 1-2 business days. For certain platforms, you may need to verify ownership via a meta tag or file in the site's
<head>section. - Auto-conversion: In Settings > Business Wallet, you can enable free auto-conversion (e.g., BTC to USDT) to reduce volatility risks.
Manage quiz categories overview
The Quiz Category Management section allows administrators to organize quiz topics. Categories are displayed in a table containing the category Title, a visual Icon for identification, and an Action menu for modifications.Modify user profiles and account balances
The Details View allows administrators to perform the following management tasks:
- Profile Customization: Update user information via input fields in the 'information about user' section.
- Verification: Manually verify the user's email or mobile number.
- Balance Management: Use the 'Account Balance' section's dropdown menus to add or subtract funds from the user's account.
- Account Status: Ban a user using the
Ban Userbutton or restore access using theUnban Userbutton. - Impersonation: Sign in as the user to view the platform from their perspective.
Administrators can also monitor three key financial metrics for the user:
- Total Balance: Current account balance.
- Total Withdrawal: Cumulative amount withdrawn by the user.
- Total Transaction: Cumulative transaction volume.
Quizix Platform Overview and Features
Quizix is a platform for creating and managing quizzes, contests, and games (such as Wordling and Hexalingo). Key features include AI-generated questions, coin systems, multi-language and RTL support, PWA support, and a secure payment system with 16+ gateways and multiple currency support (including live exchange rate updates). It also provides admin role management, reports with PDF/Excel export, and customizable notification templates for Email, SMS (via Twilio and Nexmo), and Push notifications (via Firebase).Analyze Dashboard chart views and login logs
The Dashboard provides several visual data representations for monitoring platform activity:
- Login Log Overview: An area chart showing user logins across desktop, tablet, and mobile devices for the last 15 days. This chart refreshes every 5 minutes.
- Contest Participants and Quizzes: A monthly breakdown of total contest participants for the current year.
- OS and Browser Distribution: An overview of user login logs categorized by operating system and browser across different device types.
Manage Wordling game words
The Manage Wordling section allows administrators to maintain the list of words used in the game. The system provides a table view showing the Word, its current Status (Active/Inactive), and available Actions (Edit/Delete).