{"id":51110591,"url":"https://github.com/newfold-labs/wp-module-onboarding","last_synced_at":"2026-06-24T17:01:54.829Z","repository":{"id":56813743,"uuid":"483034073","full_name":"newfold-labs/wp-module-onboarding","owner":"newfold-labs","description":"Next-generation WordPress Onboarding via Newfold Module","archived":false,"fork":false,"pushed_at":"2026-06-15T16:13:55.000Z","size":171392,"stargazers_count":35,"open_issues_count":20,"forks_count":10,"subscribers_count":9,"default_branch":"main","last_synced_at":"2026-06-15T18:12:18.369Z","etag":null,"topics":["wordpress","wp-admin","wp-module","wp-scripts"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/newfold-labs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2022-04-18T23:57:10.000Z","updated_at":"2026-06-10T13:38:41.000Z","dependencies_parsed_at":"2024-03-18T08:49:15.346Z","dependency_job_id":"51f3c014-f311-4fe4-b813-05daa99f6536","html_url":"https://github.com/newfold-labs/wp-module-onboarding","commit_stats":null,"previous_names":[],"tags_count":150,"template":false,"template_full_name":null,"purl":"pkg:github/newfold-labs/wp-module-onboarding","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/newfold-labs%2Fwp-module-onboarding","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/newfold-labs%2Fwp-module-onboarding/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/newfold-labs%2Fwp-module-onboarding/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/newfold-labs%2Fwp-module-onboarding/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/newfold-labs","download_url":"https://codeload.github.com/newfold-labs/wp-module-onboarding/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/newfold-labs%2Fwp-module-onboarding/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34741320,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-24T02:00:07.484Z","response_time":106,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["wordpress","wp-admin","wp-module","wp-scripts"],"created_at":"2026-06-24T17:01:54.751Z","updated_at":"2026-06-24T17:01:54.821Z","avatar_url":"https://github.com/newfold-labs.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ca href=\"https://newfold.com/\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://newfold.com/content/experience-fragments/newfold/site-header/master/_jcr_content/root/header/logo.coreimg.svg/1621395071423/newfold-digital.svg\" alt=\"Newfold Logo\" title=\"Newfold Digital\" align=\"right\" \nheight=\"42\" /\u003e\n\u003c/a\u003e\n\n# WordPress Onboarding Module\n[![Version Number](https://img.shields.io/github/v/release/newfold-labs/wp-module-onboarding?color=77dd77\u0026labelColor=00000\u0026style=for-the-badge)](https://github.com/newfold/wp-module-onboarding/releases)\n[![License](https://img.shields.io/github/license/newfold-labs/wp-module-onboarding?labelColor=333333\u0026color=666666\u0026style=for-the-badge)](https://raw.githubusercontent.com/newfold-labs/wp-module-onboarding/master/LICENSE)\n\n\nThe Onboarding module is designed to streamline various tasks related to user onboarding and customization within a WordPress environment. It provides functionalities to enhance user experience, configure settings, install plugins and themes dynamically, and interact with other modules seamlessly.\n\u003cbr\u003e\u003cbr\u003e\n[![React](https://img.shields.io/badge/Wordpress-21759B?style=for-the-badge\u0026logo=wordpress\u0026logoColor=white)]()\n[![React](https://img.shields.io/badge/PHP-777BB4?style=for-the-badge\u0026logo=php\u0026logoColor=white)]()\n[![React](https://shields.io/badge/react-black?logo=react\u0026style=for-the-badge)]()\n\u003cbr\u003e\n\n## Module Responsibilities\n\n### Common Grounds\n\n- Automatically upgrade WordPress versions for users running below version 6.2, ensuring security and performance improvements.\n- Initialize WordPress options, permalinks, and configurations to ensure a consistent setup across users.\n- Provide functions to redirect users after login, ensuring a smooth transition and a complete onboarding experience.\n- Install various plugins and themes dynamically based on user requirements, enhancing customization options.\n- Show a completely different experience to users based on the brands they are redirected from, enhancing brand consistency and personalization.\n- Send various events according to user selections, enabling tracking and analytics for user behavior.\n- Interact with the Onboarding Data Module for various operations and tasks, ensuring seamless user experience.\n\n### Default Flow [wp-setup]\n\n- Defines appropriate Primary and Secondary categories in the Site Classification section within the Data Module.\n- Incorporate the title, description, and logo supplied by the user for their WordPress site.\n- Transition to an ecommerce flow if the user selects \"Selling\" as the Top Priority Step.\n- Produce themes featuring templates such as headers, homepages, and supplementary pages, tailored to the user's preferences, including selected colors and fonts.\n\n### Ecommerce Flow [ecommerce]\n\n- This flow has supplementary stages, including address input, tax particulars, and product configuration.\n- User-provided address details are seamlessly integrated into the WooCommerce plugin, with the default currency adapted based on user selections.\n- The Tax step facilitates the establishment of default tax calculation preferences.\n- The Products step, users can define the type and quantity of products they intend to sell.\n\n### Sitegen Flow [sitegen]\n\n- Users are presented with the option to proceed through either the standard DIY process or the cutting-edge Sitegen Flow.\n- Users have the capability to integrate their Facebook accounts to elevate the website creation experience.\n- Many pivotal elements of the site are synthesized through AI calls.\n- Users are presented with various iterations of their site and have the ability to generate multiple versions with distinct styles.\n- They can personalize the visual aspects of the website, including color schemes, typography, and even the theme name.\n- A customized child theme is created based on the user's preferences, accompanied by a live preview showcasing the website's appearance.\n\n## Critical Paths\n\n### Common Grounds\n\n   - Users should be automatically redirected to the onboarding process the first time they log in to wp-admin.\n   - Subsequent logins to WordPress should not display the onboarding process for users who have completed it previously.\n   - Users should be guided to upgrade the WordPress version if it is less than 6.2.\n   - Users should experience a brand-specific interface, displaying different brand logos and colors tailored to their brand affiliation.\n   - The child theme generated should reflect the choices made by the user during their onboarding experience.\n\n### Default Flow [wp-setup]\n\n- Primary and secondary classifications should be promptly established in the SiteClassification option upon the user's selection.\n- The workflow should seamlessly switch when the user prioritizes \"Selling\" in the Top Priority step.\n- Users should be presented with a choice between Wonder Blocks or YITH Wonder Live Previews options.\n- The Live preview should vividly illustrate the user's selections, providing a visual depiction of the site's appearance.\n\n### Sitegen Flow [sitegen]\n\n- Ensure that all Site meta requests are executed concurrently and that data processing proceeds smoothly.\n- Validate the functionality of all live previews, showcasing various iterations of the site.\n- Generate and publish additional pages according to the user's instructions.\n- Apply the chosen color schemes and fonts, allowing users to observe immediate updates reflected in their live previews.\n- Upload large AI-generated images into WordPress media and incorporate the new WordPress links into their respective contexts.\n- Generate screenshots tailored to the user's preferences and create a child theme using the provided name.\n\n## Release Process\n\nRun the `Newfold Prepare Release` github action to automatically bump the version (either patch, minor or major version), and update build and language files all at once. It will create a PR with changed files for review. Using this workflow, we can skip all the manual steps below.\n\n### Manual Release Preparation\n\n1. **Checkout the trunk branch locally:**\n   ```bash\n   git checkout trunk\n   ```\n\n2. **Ensure trunk is up to date with origin:**\n   ```bash\n   git pull origin trunk\n   ```\n\n3. **Create release branch, where [x.y.z] is the new version (following Semantic Versioning):**\n   ```bash\n   git branch release/[x.y.z]\n   ```\n\n3. **Test for any breaking changes and highlight concerns:**\n   - **Conduct thorough testing to ensure stability and functionality.**\n   - Note any issues or concerns for further action.\n\n4. **Increment Version via script**\n   - Update versions and rebuild manually:\n      1. **Increment version [x.y.z]**\n         - Update version in:\n         - `bootstrap.php`\n         - `package.json`\n         - Run:\n         ```bash\n         npm install\n         npm run build\n         ```\n         - Verify existence of `build/\u003cnew_version\u003e` folder.\n         - Remove previous release build files: `build/\u003cold_version\u003e` folder.\n         - Update language files. Run: `composer run i18n`.\n\n5. **Push changes to origin:**\n   ```bash\n   git push origin trunk\n   ```\n\n### Creating a Release on Github\n\n6. **Create a new release on Github:**\n   - Go to: [New Release](https://github.com/newfold-labs/wp-module-onboarding/releases/new)\n   - Tag number should match the updated version number.\n   - Title: `Version \u003ctag_number\u003e`\n   - Generate release notes.\n   - Publish Release.\n\n7. **Ensure release tag exists on [Github](https://github.com/newfold-labs/wp-module-onboarding/releases/) and [Satis](https://github.com/newfold-labs/satis/actions).**\n\n### Pull Request and Cypress Testing\n\n8. **Make a branch in the Brand Plugin:**\n   - Create a branch `update/onboarding` in the Brand plugin from `develop`.\n\n9. **Update Onboarding version in:**\n   - `composer.json`\n   - `composer.lock`\n   - Run:\n     ```bash\n     composer update newfold-labs/wp-module-onboarding\n     ```\n\n10. **Push changes to the branch and add a small release description in the PR Desc.**\n\n11. **Wait for Cypress test workflow to run:**\n    - Ensure all Onboarding tests pass.\n\n12. **If any tests fail, fix them in the module and tag a re-release by deleting the earlier release and tag.**\n\n### Final Steps\n\n13. **Create a bump PR to the master branch of Brand Plugin.**\n\n14. **Send release details notification on WordPress Pillar APAC channel.**\n\n15. **Tag PRESS1 and share link in PRESS 1,2,4 Coordination Code Reviews channel:**\n    - Include Release Tag and Bump PR links.\n\n## Installation\n\n### 1. Add the Newfold Satis to your `composer.json`.\n\n ```bash\n composer config repositories.newfold composer https://newfold-labs.github.io/satis\n ```\n\n### 2. Require the `newfold-labs/wp-module-onboarding` package.\n\n ```bash\n composer require newfold-labs/wp-module-onboarding\n ```\n\n[More on Newfold WordPress Modules](https://github.com/newfold-labs/wp-module-loader)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnewfold-labs%2Fwp-module-onboarding","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnewfold-labs%2Fwp-module-onboarding","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnewfold-labs%2Fwp-module-onboarding/lists"}