Merge pull request #177 from gadget-inc/move-readme-to-root-dir

Created READMEs for all current templates

Author: gabeb03

openai/screenwriter-noauth-rrv7-f-ssr/README.md

@@ -0,0 +1,31 @@
+# AI Screenwriter
+
+## Core purpose
+
+This template is a great starting point to build AI applications. It comes pre-configured with an OpenAI connection, allowing you to quickly build features like automated script writing, character dialogue generation, or any other creative writing task.
+
+## Key functionality
+
+- **AI-powered content generation**: Leverages a built-in OpenAI connection to generate movie scripts, quotes, and other creative text based on user prompts.
+- **Real-time streaming**: Includes an example of how to stream AI responses directly to the frontend, providing a dynamic and interactive user experience.
+- **Semantic search-ready**: The `movie` model includes a vector field for `embedding`, laying the groundwork for building a semantic search feature to find similar movies based on their quotes or titles.
+
+## Key features
+
+- Models
+
+  - `movie`: Stores movie titles, quotes, and vector embeddings
+  - User: Manages signups and user information.
+
+- Global actions:
+
+  - `ingestData`: Fetches movie data from Hugging Face, sends it to OpenAI for embeddings, and stores the results.
+  - `findSimilarMovies`: Uses a user-submitted quote to find similar quotes from the database and generates screenplay suggestions based on vector embeddings.
+
+- Routes
+
+  - `POST-chat`: Streams responses from the OpenAI API to the client.
+
+- Frontend
+
+  - `App.jsx`: Manages routing for the application's frontend.

shopify/product-bundler-public-remix-ssr/README.md

@@ -0,0 +1,73 @@
+# Customized Bundles
+
+## Core Purpose
+
+This app enables Shopify merchants to create, manage, and sell product bundles. It allows merchants to group several individual product variants into a single, purchasable unit, offering curated packages to customers and increasing the average order value.
+
+## Key Functionality
+
+The app provides an admin interface for merchants to define a product variant as a "bundle" and associate other product variants as its components, each with a specified quantity. This bundle data is synchronized with Shopify using metafields. When a customer adds a bundle to their cart, a Shopify Function automatically expands the bundle into its individual component products. This ensures that inventory is tracked correctly and that fulfillment processes are seamless. The app maintains a real-time sync with the merchant's product catalog and manages all bundle logic within the Shopify ecosystem.
+
+Relevant Shopify docs:
+
+- [metafieldDefinitionCreate](https://shopify.dev/docs/api/admin-graphql/2024-07/mutations/metafieldDefinitionCreate): Used 3 times to create the metafields `isBundle`, `componentReference` and `productVariantQuantities`
+- [cartTransformCreate](https://shopify.dev/docs/api/admin-graphql/2024-07/mutations/cartTransformCreate): Creates the Cart Transform function on the store installing the application
+- [publications](https://shopify.dev/docs/api/admin-graphql/2024-07/queries/publications): Fetches a list of publications (sales channels) for the store. This is used to specifically fetch the `Online Store` sales channel
+- [productCreate](https://shopify.dev/docs/api/admin-graphql/2024-07/mutations/productCreate): Used when a bundle is created to set title, price, product status and description
+- [productVariantUpdate](https://shopify.dev/docs/api/admin-graphql/2024-07/mutations/productVariantUpdate): Used to set the components of the bundle and their quantities when a bundle is created or updated
+- [publishablePublish](https://shopify.dev/docs/api/admin-graphql/2024-07/mutations/publishablePublish): Called on bundle creation to publish it to the `Online Store`
+- [productUpdate](https://shopify.dev/docs/api/admin-graphql/2024-07/mutations/productUpdate): Used to update the title, price, status and description of the bundle
+- [metafieldsSet](https://shopify.dev/docs/api/customer/2024-07/mutations/metafieldsSet): Used to modify the quantities of components in the bundle
+
+## Setup
+
+Follow these steps to get the template working:
+
+1. [Connect to Shopify](https://docs.gadget.dev/guides/tutorials/connecting-to-shopify#connecting-to-shopify) using our built-in Shopify plugin.
+
+2. Sync the code locally using `ggt` ([Gadget CLI](https://docs.gadget.dev/reference/ggt#ggt-reference)) and run `yarn shopify:dev` to test the application. Make sure to install the [Shopify CLI](https://shopify.dev/docs/api/shopify-cli#installation) using these instructions.
+
+3. While dev is running, press the `g` key to open the Shopify GraphiQL UI and run the following command to get your development Cart Transform function id. Add this function id to the `BUNDLER_FUNCTION_ID` environment variable of your development environment.
+
+```graphql
+query {
+  shopifyFunctions(first: 25) {
+    nodes {
+      app {
+        title
+      }
+      apiType
+      title
+      id
+    }
+  }
+}
+```
+
+4. In the Shopify Partner dashboard, navigate to the `Extensions` tab and turn on `Development store preview`. This will allow you to run the Shopify Function on your development store.
+
+5. Install the application on a development store, create a bundle and test the function. When testing, make sure that you're always running `yarn dev`.
+
+## Key features
+
+- Models
+
+  - Bundle: Stores data about product bundles, including title, description, status, price, and components.
+    - Actions
+      - `create`: Used to create bundles using the Shopify API.
+      - `update`: Used to update existing bundles using the Shopify API.
+  - BundleComponent: Manages the relationship between bundles and product variants, including the quantity of each variant.
+  - ShopifyShop: Stores shop data related to the Shopify store's configuration.
+    - Actions
+      - `install`: Sets up metafield definitions, the cart transformation function, and retrieves information about the shop's sales channels.
+
+- Frontend
+
+  - `_app._index`: Displays a list of created bundles, expandable to show their components and quantities.
+  - `_app.bundle.($id)`: Manages both the creation and update of bundles.
+
+- Global Actions
+
+  - `createBundleInShopify`: Handles all Shopify API mutations necessary to create a new product, update its variant, and set bundle metafields.
+  - `updateBundleInShopify`: Updates the bundle product, its variant, and relevant metafields based on input data.
+  - `updateBundleComponentQuantity`: Sets the quantity value in the `productVariantQuantities` metafield.

shopify/product-quiz-public-remix-ssr/.template/docs/assets/env-app-slug.png

@@ -0,0 +1,92 @@
+# Product quiz
+
+## Core purpose
+
+The application enables store owners to build custom quizzes through the Shopify admin interface. Each quiz consists of multiple questions with various answer options, and merchants can associate specific product recommendations with different answer combinations. When customers take a quiz, their responses are analyzed to generate personalized product suggestions, creating a more engaging and guided shopping experience.
+
+The app includes both an admin interface for merchants to manage their quizzes (create, edit, and configure product mappings) and a customer-facing quiz interface that can be embedded directly into Shopify storefronts via a theme extension. Customer quiz results and product suggestions are tracked, allowing merchants to analyze engagement and optimize their product recommendations over time.
+
+## Setup
+
+The following is a guide to get you started with the product quiz. If you get lost, try following the [full tutorial](https://docs.gadget.dev/guides/tutorials/product-recommendation-quiz-app).
+
+1. [Connect to Shopify](https://docs.gadget.dev/guides/tutorials/connecting-to-shopify#connecting-to-shopify) using our built-in Shopify plugin.
+
+2. Make sure that you have the [Shopify CLI](https://shopify.dev/docs/api/shopify-cli#installation) installed locally.
+
+3. Find the application slug and the environment slug. You'll need them for step 4.
+
+![Photo showing where to find the app and env slug in Gadget UI](./.template/docs/assets/env-app-slug.png)
+
+4. Create a shopify app proxy that has proxy URL matching `https://<application-slug>--<env-slug>.gadget.app/proxy`. Note the subpath used in the theme app extension's JS file. For more information on Shopify app proxies, read the [Shopify docs](https://shopify.dev/docs/apps/build/online-store/display-dynamic-data)
+
+## Setting up liquid files (Online store 1.0)
+
+For themes using Online Store 1.0, instructions are included in the **Install** tab of the admin app. You need to manually copy-paste code files included in the app into the theme.
+
+## Setting up App Theme Extension (Online store 2.0)
+
+In order to set up a theme app extension for stores using a new Online Store 2.0 theme:
+
+- Update `extensions/quiz/blocks/quiz-page.liquid` by replacing the src on line 7 with your script tag
+- Run `yarn dev` in the project root to start the development environment (Shopify CLI)
+- Follow Shopify's prompts to connect to your existing Partners app and store
+
+## Key features
+
+- Models
+
+  - Quiz: Framework for creating and storing quizzes.
+    - Fields
+      - `slug`: The slug that will be used to determine which quiz to show the customer
+      - `title`: The title of the product quiz
+      - `results`: A hasMany relationship to the results of this quiz
+      - `questions`: The questions on the quiz
+  - Question: Individual questions included in a quiz.
+    - Fields
+      - `text`: The body of the question
+      - `quiz`: The quiz that the question belongs to
+      - `answers`: The answers associated to the question
+  - Answer: Possible answers for a quiz question.
+    - Fields
+      - `text`: The body of the answer
+      - `question`: The question that the answer belongs to
+      - `recommendedProduct`: The product that is recommended for this answer
+  - RecommendedProduct: A Shopify product recommended to shoppers based on their quiz answers.
+    - Fields
+      - `productSuggestion`: The suggested product
+      - `answer`: The answer that the recommendation belongs to
+  - QuizResult: Captures the shopper's email and the products recommended to them based on their quiz answers.
+    - Fields
+      - `email`: The email of the customer that filled out the form
+      - `shopperSuggestion`: The product that was recommended to the customer
+      - `quiz`: The quiz that the result record belongs to
+  - ShopperSuggestion: Handles the has-many-through relationship between quizResult and shopifyProduct.
+    - Fields
+      - `product`: The product that the suggestion belongs to
+      - `quizResult`: The quiz result record that the product belongs to
+  - ShopifyTheme: Tracks whether a theme is using Shopify's Online Store 2.0.
+    - Fields
+      - `usingOnlineStore2`: Boolean field signifying if the store is using a Shopify 2.0 theme
+
+- Frontend
+
+  - `App.jsx`: Handles routing for the frontend pages.
+  - `HomePage.jsx`: Main page for the Shopify admin app.
+  - `CreateQuizPage.jsx`: Contains the form for creating new quizzes.
+  - `EditQuizPage.jsx`: Contains the form for editing existing quizzes.
+  - `QuizForm.jsx`: Entry point for the form used to create and edit quizzes.
+  - `InstallTab.jsx`: Provides installation instructions for adding the quiz to the storefront.
+  - `Store1Instructions.jsx`: Manual instructions for themes built on Online Store 1.0.
+
+- Actions
+
+  - `quiz/create`: Generates an ID/slug when a quiz is created (e.g., "My Cool Quiz" becomes "my-cool-quiz").
+  - `quiz/delete`: Cascading delete that removes a quiz along with its questions, answers, and recommended products.
+  - `shopifyAsset/create`: Detects whether the shop is using Shopify Storefront 1.0 or 2.0.
+  - `shopifyAsset/update`: Updates to detect the shop’s storefront version.
+
+- Access Controls
+
+  - `unauthenticated`: Quizzes can be viewed by anyone who visits the shop, regardless of whether they are logged in.
+  - `shopify-app-users`: Merchants can only read themes from their store.

shopify/product-quiz-public-remix-ssr/README.md

@@ -6,4 +6,4 @@
 
 3. Run the `shopify app dev` command in the Gadget terminal
 
-4. Embed your theme app extension on the product page of your devalopment store
+4. Embed your theme app extension on the product page of your development store

shopify/product-reviews-public-remix-ssr/.template/docs/assets/env-app-slug.png

@@ -0,0 +1,43 @@
+# Product Reviews
+
+## Core purpose
+
+This app enables Shopify merchants to collect, manage, and display customer reviews for their products. It provides an automated review collection system that requests feedback from customers after purchase, along with a comprehensive admin interface for review moderation and a storefront display system.
+
+## Key functionality
+
+The app automatically sends review request emails to customers based on configurable timing after order fulfillment. Customers can submit reviews through a secure, code-based system that doesn't require account creation. Merchants can approve or reject reviews through the admin interface, and approved reviews are displayed on product pages via a theme extension. The system syncs review data with Shopify using metafields, maintaining review summaries and ratings directly in the merchant's product catalog for seamless integration with their storefront.
+
+## Setup
+
+1. [Connect to Shopify](https://docs.gadget.dev/guides/tutorials/connecting-to-shopify#connecting-to-shopify) using our built-in Shopify plugin
+
+2. Find the application slug and the environment slug. You'll need them for step 3.
+
+![Photo showing where to find the app and env slug in Gadget UI](./.template/docs/assets/env-app-slug.png)
+
+3. Create a shopify app proxy that has proxy URL matching `https://<application-slug>--<env-slug>.gadget.app/proxy`. Note the subpath used in the theme app extension's JS file. For more information on Shopify app proxies, read the [Shopify docs](https://shopify.dev/docs/apps/build/online-store/display-dynamic-data)
+
+4. Run the `shopify app dev` command in the Gadget terminal
+
+5. Embed your theme app extension on the product page of your development store
+
+## Key features
+
+- Models
+
+  - `review`: Stores review data including the rating, content, and approval status, and links to the corresponding product, customer, and order.
+  - `shopifyShop`: Extended with settings for review requests, like `daysUntilReviewRequest`.
+  - `shopifyOrder`: Extended to manage when review requests are sent.
+
+- Frontend
+
+  - `web/routes/_app._index.tsx`: The main dashboard for merchants to view and manage product reviews.
+  - `web/rotues/_public.review.($code).tsx`: A public page where customers can submit a review for their purchase.
+  - `extensions/product-reviews/blocks/productReviews.liquid`: A theme extension block to display approved reviews on product pages.
+
+- Actions
+
+  - `review/create, update, delete`: Allow for the management and approval of reviews.
+  - `sendReviewRequests`: A scheduled action to email customers asking for a review after their purchase.
+  - `createReviewMetaobject` & `updateReviewsMetafield`: Actions to store review data as Shopify metaobjects and metafields, making them accessible on the storefront.