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

feat(UST-1087): create nuxt and next packages #6997

Merged
merged 32 commits into from
Jan 5, 2024
Merged

Conversation

jagoral
Copy link
Contributor

@jagoral jagoral commented Dec 13, 2023

πŸ”— Linked issue

❓ Type of change

  • πŸ“– Documentation (updates to the documentation, readme or JSDoc annotations)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

  • Created a @vue-storefront/nuxt package for Vue Storefront 2
  • Created a @vue-storefront/nextjs package (support for Pages and App Router)
  • Added a Nuxt Module which facilitates the setup of SDK for Nuxt Storefronts
  • Added unit and shared e2e tests
  • Added a base README for the module, presenting how to set it up
  • nuxt package requires Node.js v18, therefore as a workaround:
    • storefront package have been placed within packages/storefront/packages dir
    • packages/storefront has been excluded from the Yarn workspaces
    • packages/storefront creates a nested workspace
    • a custom continuous-delivery-storefront.yml workflow has been created (runs tests on Node18)
    • release of storefront packages wouldn't be possible with changeset, till we will migrate the whole repo to Node18, we will have to release them manually
  • for Next.js @vue-storefront/next/client entry is exported, where a "use client" directive is used, so the code can be used in App Router

How to test it locally?

  1. cd packages/storefront
  2. yarn

Then for Next

  1. cd packages/next
  2. yarn build
  3. yarn dev:middleware in one terminal
  4. yarn dev:pages-router or yarn dev:app-router in second terminal

or Nuxt

  1. cd packages/nuxt
  2. yarn build
  3. yarn dev:middleware in one terminal
  4. yarn dev:pages-router or yarn dev in second terminal

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.
  • JSDocs included

@jagoral jagoral force-pushed the feat/UST-1087-nuxt-package branch from fb15420 to dc2c40c Compare December 13, 2023 07:39
@jagoral jagoral force-pushed the feat/UST-1087-nuxt-package branch from dc2c40c to 5263672 Compare December 13, 2023 07:41
@jagoral jagoral force-pushed the feat/UST-1087-nuxt-package branch from cb1dc8e to 1bcfab3 Compare December 17, 2023 12:50
@jagoral jagoral changed the title feat(UST-1087): create @vue-storefront/nuxt package for Vue Storefront 2 feat(UST-1087): create @vue-storefront/nuxt and @vue-storefront/next packages Dec 18, 2023
@jagoral jagoral changed the title feat(UST-1087): create @vue-storefront/nuxt and @vue-storefront/next packages feat(UST-1087): create nuxt and next packages Dec 18, 2023
@jagoral jagoral force-pushed the feat/UST-1087-nuxt-package branch 10 times, most recently from d29f2e8 to 7f53c4c Compare December 18, 2023 12:43
@jagoral jagoral force-pushed the feat/UST-1087-nuxt-package branch from 7f53c4c to 181e919 Compare December 18, 2023 12:46
@jagoral jagoral force-pushed the feat/UST-1087-nuxt-package branch from ca4eeb6 to 580d243 Compare December 18, 2023 13:22
@jagoral jagoral force-pushed the feat/UST-1087-nuxt-package branch from 28817f4 to fcf8579 Compare December 18, 2023 15:05
@jagoral jagoral force-pushed the feat/UST-1087-nuxt-package branch from fcf8579 to 78b55c8 Compare December 18, 2023 15:09
@jagoral jagoral force-pushed the feat/UST-1087-nuxt-package branch 3 times, most recently from de9b645 to 7c95239 Compare December 21, 2023 05:56
@jagoral jagoral force-pushed the feat/UST-1087-nuxt-package branch from 7c95239 to c55bd74 Compare December 21, 2023 06:22
@skirianov
Copy link
Contributor

Added docs for getting started with Next, Nuxt, and Framework Agnostic

@jagoral @filrak please let me know wdyt

@skirianov
Copy link
Contributor

fixed CR @jagoral

@filrak can you lift your change requested?

@jagoral jagoral requested a review from filrak December 22, 2023 10:49
@jagoral jagoral merged commit d2ce487 into main Jan 5, 2024
12 checks passed
@jagoral jagoral deleted the feat/UST-1087-nuxt-package branch January 5, 2024 09:05
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 this pull request may close these issues.

5 participants