https://github.com/vtex-apps/pixel-app-template
https://github.com/vtex-apps/pixel-app-template
hacktoberfest store-framework vtex-io
Last synced: 27 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/vtex-apps/pixel-app-template
- Owner: vtex-apps
- Created: 2019-08-23T18:21:21.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-04-09T17:35:18.000Z (10 months ago)
- Last Synced: 2025-04-09T18:43:20.383Z (10 months ago)
- Topics: hacktoberfest, store-framework, vtex-io
- Language: TypeScript
- Homepage:
- Size: 186 KB
- Stars: 18
- Watchers: 40
- Forks: 17
- Open Issues: 2
-
Metadata Files:
- Readme: docs/README.md
- Changelog: CHANGELOG.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
📢 Use this project, [contribute](https://github.com/vtex-apps/CHANGEME) to it or open issues to help evolve it using [Store Discussion](https://github.com/vtex-apps/store-discussion).
# APP NAME
[](#contributors-)
Under the app's name, you should explain the topic, giving a **brief description** of the **app's functionality** (what is it for?) in a store.
Next, you can **add media** (either an image of a GIF) if possible, so that users can better understand how the app works in practice.
## Configuration
It is possible to install in your store either by using App Store or the VTEX IO Toolbelt.
### Using VTEX App Store
1. Access the **Apps** section in your account's admin page and look for the Icommkt box;
2. Then, click on the **Install** button;
3. You'll see a warning message about needing to enter the necessary configurations. Scroll down and type in your **NAME OF A SETTINGS FIELD** in the `NAME OF THE APP` field.
4. Click on **Save**.
### Using VTEX IO Toolbelt
1. [Install](https://vtex.io/docs/recipes/development/installing-an-app/) the `vtex.icommkt@0.x` app. You can confirm that the app has now been installed by running `vtex ls` again.
2. Access the **Apps** section in your account's admin page and look for the NAME OF THE APP box. Once you find it, click on the box.
3. Fill in the `NAME OF THE APP` field with your **NAME OF THE SETTINGS FIELD**.
4. Click on **Save**.
## Modus Operandi *(not mandatory)*
There are scenarios in which an app can behave differently in a store, according to its configuration. It's crucial then to go through these **behavioral changes** in this section, allowing users to fully understand the **practical application** of the app in their store.
If you feel compelled to give further details, such as the app's **relationship with others**, don't hesitate to use this section.
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind are welcome!