Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FH-2] Amazon Wishlist #156

Open
FTCHD opened this issue Sep 5, 2024 · 0 comments · Fixed by #183
Open

[FH-2] Amazon Wishlist #156

FTCHD opened this issue Sep 5, 2024 · 0 comments · Fixed by #183

Comments

@FTCHD
Copy link
Owner

FTCHD commented Sep 5, 2024

Part of FrameHack2 (300 PTS)

ℹ️ Terminology

  • Viewer: The person using the Frame on a client.

  • User: The person who created the Frame on FrameTrain.

  • Creator: The person who created the template from which the Frame was created. This is you, creating a template right now!

  • View: A React component that is called by a handler (like a controller in MVC architecture), which then gets rendered using Satori and returned as image.

  • BasicView: A specific, existent, pre-made React component imported from @/sdk/components that is used for common scenarios where you need just a title, a (optional) subtitle and a (optional) bottom message. It was made so creators don’t write the same basic component over and over again. It also comes with a matching component to use in your Inspector to let the User customize it named BasicViewInspector, click here for details.

  • Handler: A function that receives the VALIDATED POST message from a Farcaster client, does the handling it needs, and returns either Frame data (metadata + a View or an image), or transaction data.

  • Inspector: A required React component present in each template that appears as the “Configuration” panel on FrameTrain. It’s the right side of the editor, and is made up of one Configuration.Root and multiple Configuration.Section's (see below). You import the Configuration parent from @/sdk/inspector.

  • Section: In order to not overwhelm the user with all the settings at once, we separate these in tabs that the user can navigate to one at a time. This is done internally, you only have to structure the content of your Inspector in multiple Section components.

  • Page: A an optional React component present in a template’s folder, that is displayed on the /${FRAME_ID}/show route. You can include such a component in your template to display a Page with a detailed view of the votes in the case of a poll template, achieving the same functionality as WePonder for example.

  • SDK: The FrameTrain SDK, located in the @/sdk folder. It provides components and utilities for gating, fonts and much more. Start reading about the SDK here.

  • Config: The configuration data the User sets in the Inspector for the current Frame being edited, which is saved in the DB and fed into the template at runtime.

  • Storage: Think of this like the state, but persisted in the DB. You receive the storage in your handler, and can return a new value for it, which updates the column in the DB.

Description

  • The purpose of this template is to provide a slideshow of Amazon products with links to each of them.

Inspector

  • Has Section s for “Importing”, “Cover”, “Product_Name”, “Success” and “Gating”.
  • The User can input a product or wishlist link, and a new Section appears for each product (ProductView). When a product is added, a new Slide is created in the Inspector.
  • The User can add product links manually, import an Amazon wishlist directly, or both.
  • The data from the product and wishlist pages is fetched using the scrape function in the SDK, which returns the rendered HTML of the page.

Views

  • Cover: displays either an image or BasicView (user picks in the Inspector).
  • Product: shows one product per slide, with back/forward navigation and a link button to Amazon.
FTCHD added a commit that referenced this issue Oct 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant