streamshop

Here’s the README translated into English:


StreamShop Components

This repository contains a collection of React components designed for the StreamShop App, an application developed for Deco's e-commerce platform. The app simplifies integration for clients to use StreamShop’s video commerce services, enabling dynamic and modular interfaces that enhance user engagement and shopping experiences.

📂 Component Structure

The main components of the project include:

  1. Banner.tsx

    • Displays banners with configurable information, including:
      • Title (title) and description (description).
      • Images for different resolutions (mobile, desktop).
      • Action buttons (cta).
      • Container width (containerWidth).
  2. Embed.tsx

    • Configuration and custom styles for dynamic embeds on the website.
  3. InfoReels.tsx

    • Displays information about Reels, including:
      • Configurable video width and height.
      • Styled content for desktop and mobile.
  4. Reels.tsx

    • Dedicated component to display videos in the Reels format.
    • Accepts a slug to identify the store.
  5. Stories.tsx

    • Manages a list of Stories with support for multiple videos.
    • Configurable titles (title), calls to action (cta), and identifiers (slugs).
  6. Widget.tsx

    • A customizable component for creating widgets:
      • Configurable horizontal and vertical position (positionX, positionY).
      • Adjustable dimensions and spacing (size, sizePosition).
      • Animation options (animation). ``

📖 Documentation

Each component includes detailed annotations to facilitate use and configuration. Use your code editor to view descriptions and available options for each prop.

🤝 Contributing

Contributions are welcome! To contribute:

  1. Fork the repository.
  2. Create a new branch for your feature or fix:
    git checkout -b my-feature
  3. Push your changes for review:
    git push origin my-feature

📝 License

This project is licensed under the MIT License. See the LICENSE file for more details.


Let me know if you'd like further adjustments! 😊

Was this page helpful?
Can't find what you're looking for? Spot an error in the documentation? Get in touch with us on our Community Forum
Continue reading