DOCSEARCHbyAlgolia
Submit Docs

ShadowDevs Documentation

website·Indexed 31 days ago

https://docs.shadowdevs.com

Documentation for a suite of developer tools and services, including Shadow Store for e-commerce management, Shopify Bot for Discord-to-Shopify integration, SPARK Vehicle Control for FiveM, Shadow License System, CDN Manager, and ShadowStatus for static status pages.

Tokens
94.7K
Snippets
349
Records
827
Agent score
50%

What's inside ShadowDevs

  1. Overview of Shadow Status architecture

    Shadow Status is a lightweight, fully static status page platform designed for GitHub Pages. It operates without a database or backend server by using the following workflow:

    1. GitHub Actions runs a monitor script (default every 15-45 minutes).
    2. The script checks configured monitors and saves results to status.json in the repository.
    3. GitHub Pages serves the static site using this JSON data.
    4. Notifications are triggered via Discord or generic webhooks when service status changes.

  2. Overview of CDN Manager capabilities

    CDN Manager is a web-based content delivery and file management system designed for organizations requiring advanced media organization, granular permissions, and robust access control. It is built to provide a secure and scalable solution for managing and delivering files.

  3. Overview of the Loyalty Program workflow

    The Loyalty Program rewards customers with points for specific actions, which can then be redeemed for store credit. The general workflow is:

    1. Customers earn points via actions (purchases, account linking, reviews).
    2. Points accumulate toward lifetime totals to unlock tiers with multipliers and perks.
    3. Points are redeemed for store credit based on a configured conversion rate.
    4. Store credit is automatically applied at checkout.

    Customers access their loyalty dashboard at the /loyalty endpoint (requires login).

  4. Overview of SPARK Vehicle Control

    SPARK Vehicle Control is a unified resource for FiveM that combines and overhauls the features of Luxart Vehicle Control (LVC) v3 and the Redneck Lighting Controller (RLC). It is designed to provide a smoother installation process and a more intuitive configuration system than using LVC and RLC separately.

  5. Overview of Personal Landing page features

    The Personal Landing page is a modern, customizable static template for showcasing personal brands, projects, and contact information. Key features include:

    • 10 Section Types: Hero, About, Services, Projects, Gallery, Timeline, Testimonials, FAQ, Links, and Contact.
    • Design Variants: Sections offer multiple layouts (e.g., the Hero section has Centered, Split, Minimal, Bold, Card, and Links variants).
    • JSON-Driven: The entire site is configured via a single config.json file, removing the need for code changes to update content.
    • Static Deployment: Compatible with any static hosting provider such as Vercel, Netlify, or GitHub Pages.
    • Responsive & Themed: Mobile-first design utilizing daisyUI's theming system for easy color customization.

  6. Overview of the Public Downloads system

    The downloads system allows administrators to publish files and releases for the community to download. Files are publicly accessible at the /downloads route. Users who are banned are blocked from accessing any /downloads/ routes and will see an error message. Accessing the management interface requires the manageDownloads permission.

  7. Overview of the Applications system

    The applications system allows for the creation of custom forms such as staff applications, event sign-ups, and feedback forms. Visitors submit responses that staff can review via the admin panel. Managing these forms requires the manageApplications permission.

  8. Shadow License System compatibility with Shadow Store

    Shadow License System is designed to be fully compatible with Shadow Store. Purchasing the full version of the license system provides access to the internal version as well.

  9. Manage server FAQs with the /faq-manage command

    The /faq-manage command allows administrators to create, edit, delete, and list frequently asked questions (FAQs) for the server. This command requires Manage Guild permissions and is only accessible to staff members.

  10. Manage product releases in Shadow Store

    The Releases feature allows for version tracking, release notes, and file distribution. Access is governed by product ownership: Free products are public by default (unless 'Require Account' is enabled), Paid products are restricted to purchasers, and Admins (users with owner or manageProducts permissions) have full access to all releases.

  11. Understand Public Blog visitor features

    Visitors can access the blog at /blog, where posts are displayed in a 3-column card grid sorted by publish date (newest first). Individual posts are accessible via /blog/[slug].

    Visitors can filter posts using:

    • Search: Full-text search across titles, excerpts, and content.
    • Tags: Filter by clicking specific tags.
    • Category: Filter by post category.
    • Author: Filter by clicking an author's name.

    Active filters appear as dismissible badges, and multiple filters can be applied simultaneously.

  12. Initialize the MongoDB database

    The Shadow License System automatically populates the database. As long as MongoDB is running, the server.js script will automatically populate the base data upon configuration and fix major database errors if they occur.