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.

Sign up for GitHub

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

fix(UST-1087): move @vue-storefront/sdk to dependencies for nuxt and next #7018

Merged
merged 2 commits into from
Jan 16, 2024
Merged

fix(UST-1087): move @vue-storefront/sdk to dependencies for nuxt and next #7018

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8f64507
fix(UST-1087): move `@vue-storefront/sdk` to dependencies in next and…
jagoral Jan 16, 2024
dea9ac9
docs: remove installing sdk from the getting started
jagoral Jan 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 3 additions & 29 deletions docs/content/4.sdk/2.getting-started/1.index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,7 @@ There are various ways to configure the SDK, depending on your chosen framework.

## Installation

Next.js SDK module is based on the Vue Storefront SDK Core. In order to use the Next.js SDK module, first you need to install the SDK Core.

```bash [SDK Core]
# Using yarn
yarn add @vue-storefront/sdk

# Using npm
npm install @vue-storefront/sdk

# Using pnpm
pnpm install @vue-storefront/sdk
```

Once SDK Core is installed, you can proceed to install Next.js SDK module. Enter the command below in the root of your project to install Next.js SDK module:
To get started with the SDK within Next.js, first you have to install the `@vue-storefront/next` package. In the root of your Storefront project run:

```bash [Next.js]
# Using yarn
Expand Down Expand Up @@ -228,22 +215,9 @@ That's it! You can now use VueStorefront SDK Module in your Next.js app ✨

## Installation

Nuxt SDK module is based on the Vue Storefront SDK Core. In order to use the Nuxt SDK module, first you need to install the SDK Core.

```bash [SDK Core]
# Using yarn
yarn add @vue-storefront/sdk

# Using npm
npm install @vue-storefront/sdk

# Using pnpm
pnpm install @vue-storefront/sdk
```

Once SDK Core is installed, you can proceed to install Nuxt SDK module. Enter the command below in the root of your project to install Nuxt SDK module:
To get started with the SDK within Next.js, first you have to install and configure the `@vue-storefront/nuxt` module.

1. Add `@vue-storefront/nuxt` dependency to your project
1. In the root of your Storefront project run:

```bash [Nuxt]
# Using yarn
Expand Down
9 changes: 9 additions & 0 deletions packages/storefront/packages/next/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Change log

## 1.0.1

- **[CHANGED]** Set `@vue-storefront/sdk` as a dependency instead of a peer dependency

## 1.0.0

- Initialized the package
6 changes: 4 additions & 2 deletions packages/storefront/packages/next/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "@vue-storefront/next",
"description": "Vue Storefront dedicated features for Next.js",
"license": "MIT",
"version": "1.0.0",
"version": "1.0.1",
"exports": {
".": {
"import": "./dist/index.mjs",
Expand Down Expand Up @@ -42,6 +42,9 @@
"test:e2e": "cd ../../shared/ && yarn test:e2e",
"test:unit": "vitest run"
},
"dependencies": {
"@vue-storefront/sdk": "^1.0.0"
},
"devDependencies": {
"@types/react": "^18.2.31",
"@types/react-dom": "^18.2.14",
Expand All @@ -51,7 +54,6 @@
"vitest": "^0.34.6"
},
"peerDependencies": {
"@vue-storefront/sdk": "^1.0.0",
"react": "^18.2.0",
"next": "^13.4.7 || ^14.0.0"
},
Expand Down
9 changes: 9 additions & 0 deletions packages/storefront/packages/nuxt/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Change log

## 3.0.1

- **[CHANGED]** Set `@vue-storefront/sdk` as a dependency instead of a peer dependency

## 3.0.0

- **[BREAKING]** Rewritten from scratch. Now the package exports a Nuxt module which allows to initialize the Vue Storefront SDK.
6 changes: 2 additions & 4 deletions packages/storefront/packages/nuxt/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@vue-storefront/nuxt",
"version": "3.0.0",
"version": "3.0.1",
"description": "Vue Storefront dedicated features for Nuxt",
"license": "MIT",
"type": "module",
Expand All @@ -27,11 +27,9 @@
"test:watch": "vitest watch",
"prepare": "nuxi prepare"
},
"peerDependencies": {
"@vue-storefront/sdk": "^1.0.0"
},
"dependencies": {
"@nuxt/kit": "3.7.4",
"@vue-storefront/sdk": "^1.0.0",
"knitwork": "^1.0.0"
},
"devDependencies": {
Expand Down
Loading