DOCSEARCHbyAlgolia
Submit Docs

Pearl Application Documentation

website·Indexed 30 days ago

https://docs-app-pearl.vercel.app/account-verification-html

Technical documentation for the Pearl application, featuring a full-stack architecture with a Django backend and React frontend. Includes detailed guides on API services (Stripe, Transaction, User), Celery task management, Django views and serializers, and a library of React components such as ResponsiveTables.js, WalletTransaction.jsx, and various UI utilities.

Tokens
238.5K
Snippets
1.2K
Records
1.5K
Agent score
74%

What's inside Pearl

  1. Overview of the RedeemFunds component

    The RedeemFunds component is a React-based modal interface that allows users to redeem funds from their wallet balance. It implements a security workflow that verifies the user's KYC (Know Your Customer) status and validates the redemption amount before processing the transaction via the redeemAmount service.

  2. Overview of the TransactionService module

    The transaction_service.py module provides a centralized service layer for creating and managing transaction records in the database. It abstracts the complexity of financial record creation to ensure consistency across the application and maintain accurate user account balances.

  3. Overview of the StripeInterface module

    The stripe_interface.py module integrates with the Stripe API to manage financial transactions. It provides a static class, StripeInterface, containing methods for creating charges, retrieving account information, creating Express accounts, generating onboarding links, and managing transfers and payouts. The module requires STRIPE_PRIVATE_TOKEN and REQUEST_URL to be configured in the Django settings.

  4. Overview of the LobbyDetail component

    LobbyDetail.js is a React component class that provides detailed information and administrative tools for a specific gaming lobby. It allows administrators to view and modify lobby details such as game type, status, player lists, and results.

  5. Overview of UserDetail.js component

    The UserDetail.js component is a React class component used to display detailed user information, manage user status (activation/deactivation), and show transaction history. It implements role-based access control to restrict actions based on the current user's permissions.

  6. Overview of versus_serializers.py

    The versus_serializers.py file defines a set of serializers used to handle the serialization, deserialization, and validation of data requests related to Versus Team operations and Challenge management within a gaming application.

  7. Overview of user_serializers.py

    The user_serializers.py file is a Django REST Framework module responsible for serialization and validation of user-related data. It handles the conversion of complex data types (like querysets and model instances) into JSON/XML and vice versa. Key functional areas include user activation, administrative staff management, financial transactions (seizures), referral systems, and permission/group management.

  8. Overview of the Activity Log Service

    The activity_log_service.py implements a threaded service (ActivityThreadService) that manages a thread-safe FIFO queue of user activity logs. To ensure high performance and avoid blocking the main application thread, the service periodically processes these entries and performs bulk insertions into the database.

  9. Overview of the Demo.js component

    The Demo.js file is a React component designed to showcase various templates and demos for the Trydo web application. It provides an interactive UI for users to explore different demo categories, inner pages, and template features. It integrates react-particles-js for animations, react-tabs for categorized content, and react-accessible-accordion for FAQs.

  10. Overview of the Paralax.jsx component

    The Paralax.jsx component creates a visually engaging webpage using parallax scrolling, where background images move slower than foreground content to create an illusion of depth. The component is structured into several functional areas: Header, Slider, Service Area, Portfolio Area, CounterUp Area, Testimonial Area, Blog Area, Brand Area, and Footer, including a 'Back to Top' navigation button.

  11. Overview of ImageSliderList component

    The ImageSliderList.js component is a React-based banner management interface. It retrieves a list of image sliders (banners) from a backend API and displays them in a responsive table. It provides administrative functionality to add, edit, and delete banners.

  12. Overview of the GlobalSettings component

    The GlobalSettings.js component is a React-based administrative interface used to view and update global configuration settings (e.g., referral bonuses, inactivity timelines). It features form validation, permission-based access control, and a confirmation workflow before submitting changes to the server.