PHPackages                             prestashop/welcome - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility &amp; Helpers](/categories/utility)
4. /
5. prestashop/welcome

AbandonedArchivedPrestashop-module[Utility &amp; Helpers](/categories/utility)

prestashop/welcome
==================

Welcome module for PrestaShop helping the users to create products.

v6.0.9(3y ago)51.1M↑21.7%29[1 PRs](https://github.com/PrestaShop/welcome/pulls)AFL-3.0PHPPHP &gt;=5.4

Since Aug 18Pushed 3y ago26 watchersCompare

[ Source](https://github.com/PrestaShop/welcome)[ Packagist](https://packagist.org/packages/prestashop/welcome)[ Docs](https://github.com/PrestaShop/welcome)[ RSS](/packages/prestashop-welcome/feed)WikiDiscussions dev Synced 1mo ago

READMEChangelog (10)Dependencies (1)Versions (32)Used By (0)

OnBoarding
==========

[](#onboarding)

[![PHP tests](https://github.com/PrestaShop/welcome/actions/workflows/php.yml/badge.svg)](https://github.com/PrestaShop/welcome/actions/workflows/php.yml)[![JS tests](https://github.com/PrestaShop/welcome/actions/workflows/js.yml/badge.svg)](https://github.com/PrestaShop/welcome/actions/workflows/js.yml)[![Latest Stable Version](https://camo.githubusercontent.com/0102512005da2e41f0b114d9a2d88212c7a9f82b18ecf30d70477dc75eccff0b/68747470733a2f2f706f7365722e707567782e6f72672f50726573746153686f702f77656c636f6d652f76)](//packagist.org/packages/PrestaShop/welcome)[![Total Downloads](https://camo.githubusercontent.com/07aed7e5e05f7b96336185c5a1dbe4839c92306edaf5772ed59bde8aff74c1fe/68747470733a2f2f706f7365722e707567782e6f72672f50726573746153686f702f77656c636f6d652f646f776e6c6f616473)](//packagist.org/packages/PrestaShop/welcome)[![GitHub license](https://camo.githubusercontent.com/499a26858588602eed043b4a48221560177258ba4ab28e566daa7791fe9a0ed2/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f50726573746153686f702f77656c636f6d65)](https://github.com/PrestaShop/welcome/LICENSE.md)

About
-----

[](#about)

Sell your first product quicker than you would have expected with our nice onboarding process.

How to customize the OnBoarding
-------------------------------

[](#how-to-customize-the-onboarding)

Every steps are stored on the config/steps.yml file.

On this file you will have groups containing the steps. Just follow this micro documentation to create / modify the steps:

```
groups:                            # Only needed once

 - title: { loc: group1.title }    # The title of the group, shown on the footer.
   steps:                          # The steps list of this group.

     # Basic configuration for each step:
     - type: popup                 # The type of the step, can be 'popup' or 'tooltip'.
       title: { loc:group1.title } # The title of the step, shown on the footer.
       text:  { loc:group1.title } # The content of the step, displayed on the popup or the tooltip
       page:  'product/new'        # The page where the step is placed
       # OR : An array of pages, when the Onboarding automaticaly move to the page, the first one
       # will be selected :
       page:  ['product/new', 'product/form']

       # Configuration only for type = 'tooltip':
       selector: '#description' # The jQuery selector where the toolip will be located
       position: top            # The position of the tooltip around the object, can be :
                                # 'left', 'right', 'top' or 'bottom'

       # Optionnal parameters:
       action:                 # Instead of just move to the next step, an action can be performed:
         selector: '#myButton' # jQuery selector where the action will be performed
         action:   'click'     # Action to perform
       options: [savepoint]    # A list of options for this step, the options can be :
                               #  - 'savepoint': If the user resume after paused, the first save
                               #      will be the last savepoint
                               #  - 'hideFooter': Hide the footer for the current step
```

Just a word for the localization:

The 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).

If you want complex content, just create a TWIG template on the *views/contents* and use `{ content: templateName }` instead of a string.

Reporting issues
----------------

[](#reporting-issues)

You can report issues with this module in the main PrestaShop repository. [Click here to report an issue](https://github.com/PrestaShop/PrestaShop/issues/new/choose).

Contributing
------------

[](#contributing)

PrestaShop modules are open source extensions to the [PrestaShop e-commerce platform](https://www.prestashop.com/). Everyone is welcome and even encouraged to contribute with their own improvements!

Just make sure to follow our [contribution guidelines](https://devdocs.prestashop.com/1.7/contribute/contribution-guidelines/project-modules/).

License
-------

[](#license)

This module is released under the [Academic Free License 3.0](https://opensource.org/licenses/AFL-3.0)

###  Health Score

44

—

FairBetter than 92% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity46

Moderate usage in the ecosystem

Community30

Small or concentrated contributor base

Maturity69

Established project with proven stability

 Bus Factor3

3 contributors hold 50%+ of commits

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~94 days

Recently: every ~153 days

Total

26

Last Release

1190d ago

Major Versions

v1.1.0 → v2.0.02017-03-15

2.0.5 → v3.0.02017-07-11

v3.0.0 → v4.0.02017-12-08

v4.0.2 → v5.0.02018-05-15

v5.1.0 → v6.0.02019-05-02

PHP version history (2 changes)v1.0.1PHP &gt;=5.4.0

v6.0.1PHP &gt;=5.4

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/15106407?v=4)[Jarvis](/maintainers/ps-jarvis)[@ps-jarvis](https://github.com/ps-jarvis)

---

Top Contributors

[![Shudrum](https://avatars.githubusercontent.com/u/2795733?v=4)](https://github.com/Shudrum "Shudrum (79 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (61 commits)")[![PierreRambaud](https://avatars.githubusercontent.com/u/1462701?v=4)](https://github.com/PierreRambaud "PierreRambaud (45 commits)")[![Progi1984](https://avatars.githubusercontent.com/u/1533248?v=4)](https://github.com/Progi1984 "Progi1984 (32 commits)")[![maximebiloe](https://avatars.githubusercontent.com/u/2203436?v=4)](https://github.com/maximebiloe "maximebiloe (25 commits)")[![Quetzacoalt91](https://avatars.githubusercontent.com/u/6768917?v=4)](https://github.com/Quetzacoalt91 "Quetzacoalt91 (16 commits)")[![aleeks](https://avatars.githubusercontent.com/u/9074610?v=4)](https://github.com/aleeks "aleeks (15 commits)")[![eternoendless](https://avatars.githubusercontent.com/u/1009343?v=4)](https://github.com/eternoendless "eternoendless (11 commits)")[![atomiix](https://avatars.githubusercontent.com/u/2168836?v=4)](https://github.com/atomiix "atomiix (9 commits)")[![thierrymarianne](https://avatars.githubusercontent.com/u/1053622?v=4)](https://github.com/thierrymarianne "thierrymarianne (9 commits)")[![matks](https://avatars.githubusercontent.com/u/3830050?v=4)](https://github.com/matks "matks (9 commits)")[![tomlev](https://avatars.githubusercontent.com/u/7364936?v=4)](https://github.com/tomlev "tomlev (8 commits)")[![jolelievre](https://avatars.githubusercontent.com/u/13801017?v=4)](https://github.com/jolelievre "jolelievre (7 commits)")[![toutantic](https://avatars.githubusercontent.com/u/720961?v=4)](https://github.com/toutantic "toutantic (5 commits)")[![kpodemski](https://avatars.githubusercontent.com/u/2137763?v=4)](https://github.com/kpodemski "kpodemski (4 commits)")[![sowbiba](https://avatars.githubusercontent.com/u/7426640?v=4)](https://github.com/sowbiba "sowbiba (4 commits)")[![Hlavtox](https://avatars.githubusercontent.com/u/6097524?v=4)](https://github.com/Hlavtox "Hlavtox (4 commits)")[![nicosomb](https://avatars.githubusercontent.com/u/121870?v=4)](https://github.com/nicosomb "nicosomb (3 commits)")[![Julievrz](https://avatars.githubusercontent.com/u/70583503?v=4)](https://github.com/Julievrz "Julievrz (3 commits)")[![alegout](https://avatars.githubusercontent.com/u/5212567?v=4)](https://github.com/alegout "alegout (2 commits)")

---

Tags

hacktoberfestnative-moduleprestashopprestashop-module

### Embed Badge

![Health badge](/badges/prestashop-welcome/health.svg)

```
[![Health](https://phpackages.com/badges/prestashop-welcome/health.svg)](https://phpackages.com/packages/prestashop-welcome)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
