Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/prestashop/welcome
This module helps merchants create their first product and discover their new shop's main features.
https://github.com/prestashop/welcome
hacktoberfest native-module prestashop prestashop-module
Last synced: 3 months ago
JSON representation
This module helps merchants create their first product and discover their new shop's main features.
- Host: GitHub
- URL: https://github.com/prestashop/welcome
- Owner: PrestaShop
- License: afl-3.0
- Archived: true
- Created: 2016-01-17T23:18:25.000Z (almost 9 years ago)
- Default Branch: dev
- Last Pushed: 2023-03-01T02:37:36.000Z (almost 2 years ago)
- Last Synced: 2024-04-26T04:00:26.109Z (9 months ago)
- Topics: hacktoberfest, native-module, prestashop, prestashop-module
- Language: PHP
- Homepage:
- Size: 1.04 MB
- Stars: 6
- Watchers: 27
- Forks: 29
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# OnBoarding
[](https://github.com/PrestaShop/welcome/actions/workflows/php.yml)
[](https://github.com/PrestaShop/welcome/actions/workflows/js.yml)
[](//packagist.org/packages/PrestaShop/welcome)
[](//packagist.org/packages/PrestaShop/welcome)
[](https://github.com/PrestaShop/welcome/LICENSE.md)
## About
Sell your first product quicker than you would have expected with our nice onboarding process.
## 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:
```yml
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
You can report issues with this module in the main PrestaShop repository. [Click here to report an issue][report-issue].
## Contributing
PrestaShop modules are open source extensions to the [PrestaShop e-commerce platform][prestashop]. Everyone is welcome and even encouraged to contribute with their own improvements!
Just make sure to follow our [contribution guidelines][contribution-guidelines].
## License
This module is released under the [Academic Free License 3.0][AFL-3.0]
[report-issue]: https://github.com/PrestaShop/PrestaShop/issues/new/choose
[prestashop]: https://www.prestashop.com/
[contribution-guidelines]: https://devdocs.prestashop.com/1.7/contribute/contribution-guidelines/project-modules/
[AFL-3.0]: https://opensource.org/licenses/AFL-3.0