{"id":15145495,"url":"https://github.com/prestashop/welcome","last_synced_at":"2025-09-29T15:30:42.816Z","repository":{"id":3680387,"uuid":"49840371","full_name":"PrestaShop/welcome","owner":"PrestaShop","description":"This module helps merchants create their first product and discover their new shop's main features.","archived":true,"fork":false,"pushed_at":"2023-03-01T02:37:36.000Z","size":1088,"stargazers_count":6,"open_issues_count":1,"forks_count":29,"subscribers_count":27,"default_branch":"dev","last_synced_at":"2024-04-26T04:00:26.109Z","etag":null,"topics":["hacktoberfest","native-module","prestashop","prestashop-module"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"afl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PrestaShop.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2016-01-17T23:18:25.000Z","updated_at":"2023-03-07T10:20:14.000Z","dependencies_parsed_at":"2023-07-05T18:48:29.462Z","dependency_job_id":null,"html_url":"https://github.com/PrestaShop/welcome","commit_stats":{"total_commits":304,"total_committers":34,"mean_commits":8.941176470588236,"dds":0.7631578947368421,"last_synced_commit":"f235607c869eedd3354fa24123d8fcb1a2d9346c"},"previous_names":[],"tags_count":26,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PrestaShop%2Fwelcome","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PrestaShop%2Fwelcome/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PrestaShop%2Fwelcome/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PrestaShop%2Fwelcome/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PrestaShop","download_url":"https://codeload.github.com/PrestaShop/welcome/tar.gz/refs/heads/dev","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234634845,"owners_count":18863945,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["hacktoberfest","native-module","prestashop","prestashop-module"],"created_at":"2024-09-26T11:40:17.591Z","updated_at":"2025-09-29T15:30:42.412Z","avatar_url":"https://github.com/PrestaShop.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OnBoarding\n\n[![PHP tests](https://github.com/PrestaShop/welcome/actions/workflows/php.yml/badge.svg)](https://github.com/PrestaShop/welcome/actions/workflows/php.yml)\n[![JS tests](https://github.com/PrestaShop/welcome/actions/workflows/js.yml/badge.svg)](https://github.com/PrestaShop/welcome/actions/workflows/js.yml)\n[![Latest Stable Version](https://poser.pugx.org/PrestaShop/welcome/v)](//packagist.org/packages/PrestaShop/welcome)\n[![Total Downloads](https://poser.pugx.org/PrestaShop/welcome/downloads)](//packagist.org/packages/PrestaShop/welcome)\n[![GitHub license](https://img.shields.io/github/license/PrestaShop/welcome)](https://github.com/PrestaShop/welcome/LICENSE.md)\n\n## About\n\nSell your first product quicker than you would have expected with our nice onboarding process.\n\n## How to customize the OnBoarding\n\nEvery steps are stored on the config/steps.yml file.\n\nOn this file you will have groups containing the steps. Just follow this micro documentation to create / modify the steps:\n\n```yml\ngroups:                            # Only needed once\n\n - title: { loc: group1.title }    # The title of the group, shown on the footer.\n   steps:                          # The steps list of this group.\n\n     # Basic configuration for each step:\n     - type: popup                 # The type of the step, can be 'popup' or 'tooltip'.\n       title: { loc:group1.title } # The title of the step, shown on the footer.\n       text:  { loc:group1.title } # The content of the step, displayed on the popup or the tooltip\n       page:  'product/new'        # The page where the step is placed\n       # OR : An array of pages, when the Onboarding automaticaly move to the page, the first one\n       # will be selected :\n       page:  ['product/new', 'product/form'] \n\n       # Configuration only for type = 'tooltip':\n       selector: '#description' # The jQuery selector where the toolip will be located\n       position: top            # The position of the tooltip around the object, can be :\n                                # 'left', 'right', 'top' or 'bottom'\n                                \n       # Optionnal parameters:\n       action:                 # Instead of just move to the next step, an action can be performed:\n         selector: '#myButton' # jQuery selector where the action will be performed\n         action:   'click'     # Action to perform\n       options: [savepoint]    # A list of options for this step, the options can be :\n                               #  - 'savepoint': If the user resume after paused, the first save\n                               #      will be the last savepoint\n                               #  - 'hideFooter': Hide the footer for the current step\n```\n\nJust a word for the localization:\n\nThe localized entries are on the _config/localization_ folder. Each entries have a key. To use one of this entry, just use ```{ loc: key.subkey }``` instead of a string. (For the titles and contents).\n\nIf you want complex content, just create a TWIG template on the _views/contents_ and use ```{ content: templateName }``` instead of a string.\n\n## Reporting issues\n\nYou can report issues with this module in the main PrestaShop repository. [Click here to report an issue][report-issue]. \n\n## Contributing\n\nPrestaShop modules are open source extensions to the [PrestaShop e-commerce platform][prestashop]. Everyone is welcome and even encouraged to contribute with their own improvements!\n\nJust make sure to follow our [contribution guidelines][contribution-guidelines].\n\n## License\n\nThis module is released under the [Academic Free License 3.0][AFL-3.0] \n\n[report-issue]: https://github.com/PrestaShop/PrestaShop/issues/new/choose\n[prestashop]: https://www.prestashop.com/\n[contribution-guidelines]: https://devdocs.prestashop.com/1.7/contribute/contribution-guidelines/project-modules/\n[AFL-3.0]: https://opensource.org/licenses/AFL-3.0\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprestashop%2Fwelcome","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprestashop%2Fwelcome","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprestashop%2Fwelcome/lists"}