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

TSOND-594 | Added VB key in next config, updated Readme & resolved snyk issue for eslint version #31

Merged
merged 1 commit into from
Nov 19, 2024
Merged
Changes from all commits
Commits
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
22 changes: 19 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -28,11 +28,27 @@ You can start editing the page by modifying `app/[locale]/page.tsx`. The page au

[Compass Starter Stack Content Repo](https://github.com/contentstack/compass-starter-stack)

## Tutorial
### Note : Contentstack stack must have English as Master Language

We have created an in-depth tutorial on how you can create a starter website using the Contentstack's Node.js SDK and fetch its content using Contentstack.
To import this content to your stack, perform the following steps:

[Build a Compass Starter Website with NextJS and Contentstack](https://www.contentstack.com/docs/developers/sample-apps/)
1. Install the CLI by running the following command in your terminal:

```npm i -g @contentstack/cli@1.28.1```

2. By default, CLI uses the North America region. To use the Europe region, run this command in your terminal:

```csdx config:set:region EU```

3. Next, log in to your Contentstack account via CLI:

```csdx auth:login```

4. Create Compass Starter stack using CLI bootstrap command

```csdx cm:bootstrap --app-name compass-app --project-dir <project-dir> --org <org-uid> -n <stack-name>```

Refer to the [Bootstrap command documentation](https://www.contentstack.com/docs/developers/cli/bootstrap-starter-apps) to learn more.

## Documentation

4 changes: 3 additions & 1 deletion next.config.mjs
Original file line number Diff line number Diff line change
@@ -24,7 +24,9 @@ const nextConfig = {
CONTENTSTACK_PERSONALIZE_PROJECT_UID: process.env.CONTENTSTACK_PERSONALIZE_PROJECT_UID,
CONTENTSTACK_AB_EXPERIENCE_ID: process.env.CONTENTSTACK_AB_EXPERIENCE_ID || '1',
CONTENTSTACK_AB_LANDING_PAGE_PATH: process.env.CONTENTSTACK_AB_LANDING_PAGE_PATH,
CONTENTSTACK_AB_PRIMARY_EVENT: process.env.CONTENTSTACK_AB_PRIMARY_EVENT || 'Clicked'
CONTENTSTACK_AB_PRIMARY_EVENT: process.env.CONTENTSTACK_AB_PRIMARY_EVENT || 'Clicked',

CONTENTSTACK_VISUAL_BUILDER_MODE: process.env.CONTENTSTACK_VISUAL_BUILDER_MODE ? process.env.CONTENTSTACK_VISUAL_BUILDER_MODE : 'builder' // mode: builder | preview
}
}

Loading