Skip to content

A mobile-first, large dataset dictionary application for WordPress utilizing WPGraphXL and Secure Custom Fields.

License

Notifications You must be signed in to change notification settings

Starisian-Technologies/sparxstar-3iatlas-dictionary

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

69 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
3iatlas

SPARXSTAR 3IAtlas Dictionary

A comprehensive WordPress plugin for managing dictionary entries with full WPGraphQL and SCF (Secure Custom Fields) integration. This plugin provides a dynamic React-based frontend dictionary interface and a robust backend management system.

CodeQL Copilot code review Copilot coding agent Dependabot Updates

Release Code Quality Final Review Security Checks

πŸš€ Features

  • Dictionary Management: Custom Post Type (aiwa_cpt_dictionary) for managing word entries.
  • Rich Taxonomies: Categorize words by:
    • Language (starmus_tax_language)
    • Dialect (starmus_tax_dialect)
    • Part of Speech (starmus_part_of_speech)
    • Alphabetical Grouping (aiwa-alpha-letter)
  • GraphQL Integration: Full schema exposure for headless or decoupled applications.
  • SCF Integration: Dynamic schema generation based on acf-json configurations.
  • React Frontend: Built-in, high-performance dictionary viewer with:
    • Virtual scrolling for large datasets.
    • Instant search with debouncing.
    • Audio pronunciation support.
    • English/French toggles.
  • Frontend Submission: Shortcode-based form for contributors to suggest new entries.

πŸ“‹ Requirements

  • PHP: 8.2 or higher
  • WordPress: 6.4 or higher
  • Plugins:
    • WPGraphQL (Required for API)
    • Secure Custom Fields (SCF) PRO or Free (Required for data structure)

πŸ› οΈ Installation

  1. Clone or download the repository into your wp-content/plugins/ directory.

  2. Install dependencies and build the assets:

    npm install
    npm run build
  3. Activate the plugin through the WordPress admin interface.

  4. Ensure SCF and WPGraphQL are installed and active.

  5. Navigate to Custom Field > Tools > Sync to ensure the fields are correctly registered from acf-json.

πŸ’» Usage

For detailed guides and notes, see the docs/ directory.

Shortcodes

Frontend Dictionary Enable users to browse the dictionary. Words are displayed alphabetically with an A-Z index to quickly jump to words beginning with the selected letter. When clicked, the definition, proununciation, example sentences, audio, images and more are displayed for each word. Users can scroll by word or scroll the full view, just like in a printed dictionary.

[sparxstar_dictionary]

Frontend Submission Form Enable logged-in users (Contributors/Editors) to add or edit dictionary entries directly from the frontend.

[sparxstar_dictionary_form]

Attributes:

  • entry_id (optional): The ID of the dictionary entry to edit.

Example:

[sparxstar_dictionary_form entry_id="123"]

GraphQL API

The plugin registers a dictionaries root query in the GraphQL schema.

Sample Query:

query GetDictionaryEntries {
    dictionaries(first: 10) {
        edges {
            node {
                title
                aiwaWordDetails {
                    aiwaTranslationEnglish
                    aiwaTranslationFrench
                    aiwaPartOfSpeech
                    aiwaExampleSentences {
                        aiwaSentence
                        aiwaSTranslationEnglish
                    }
                }
                starmusTaxLanguages {
                    nodes {
                        name
                    }
                }
            }
        }
    }
}

πŸ—οΈ Development

Architecture

  • Root: sparxstar-3iatlas-dictionary.php (Bootloader)
  • Core Logic: src/core/SparxstarIAtlasOrchestrator.php
  • Post Types: src/includes/SparxstarIAtlasPostTypes.php
  • Frontend: src/js/app.jsx (React Application)

Build Commands

  • npm run build: Compile and minify assets for production.
  • npm run watch: specific watch command for development.
  • npm run lint: Run ESLint and Stylelint.

🀝 Contributing

  1. Follow the PSR-4 coding standard for PHP.
  2. Ensure React components in src/js are functional and use hooks.

πŸ“„ License

License: Starisian Technologies Proprietary License (STPD) Copyright (c) 2026 Starisian Technologies. All rights reserved.

SPARXSTAR and Starisian Technologies is a trademark of Starisian Technologies.

NOTICE: All information contained herein is, and remains, the property of Starisian Technologies and its suppliers, if any. The intellectual and technical concepts contained herein are proprietary to Starisian Technologies and its suppliers and may be protected by U.S. and international copyright, trade secret, and patent laws, including patents in process.

Unauthorized reproduction, redistribution, transmission, or disclosure of any part of this repository is strictly prohibited without prior written consent from Starisian Technologies.

About

A mobile-first, large dataset dictionary application for WordPress utilizing WPGraphXL and Secure Custom Fields.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Sponsor this project

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •