Skip to content
Merged
Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "Optimizely VueJS Starter Kit",
"name": "Optimizely Vue.js Starter Kit",

"build": {
"dockerfile": "Dockerfile",
Expand Down
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Optimizely Vue.js Starter Kit

The goal of this repo is to get you to a running Vue app with Optimizely as fast as possible.
The goal of this repo is to get you to a running [Vue](https://vuejs.org/) app with Optimizely as fast as possible.

## Prerequisites

Expand All @@ -16,14 +16,13 @@ To get started with the application, follow these steps:

1. Open Visual Studio Code and press `Ctrl + Shift + P` (or `Cmd + Shift + P` on macOS) to open the command palette. Type "Dev Containers: Clone Repository in Container Volume" and press Enter.
2. Enter the repository address `https://github.com/optimizely/vue-js-starter-kit`.
3. If asked, choose the `main` branch.
4. Once the repository is cloned and opened in the dev container, run the project by opening a terminal in Visual Studio Code (press ```Ctrl + ` ``` (or ```Cmd + ` ``` on macOS) and execute the following command:
3. Once the repository is cloned and opened in the dev container, run the project by opening a terminal in Visual Studio Code (press ```Ctrl + ` ``` (or ```Cmd + ` ``` on macOS) and execute the following command:

```shell
npm run dev
```
5. Click the link to the http://localhost:5173/ address to open a browser to the running Vue app.
6. Use the "Run" navigation link after reading the Quick Start information on the home page.
4. Click the link to the http://localhost:5173/ address to open a browser to the running Vue app.
5. Use the "Run" navigation link after reading the Quick Start information on the home page.

## To Exit

Expand Down
2 changes: 1 addition & 1 deletion src/App.vue
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { RouterLink, RouterView } from 'vue-router'
import HelloWorld from './components/HelloWorld.vue'
import optimizelySdk from '@optimizely/optimizely-sdk'

const optimizelyClient = optimizelySdk.createInstance({ sdkKey: 'K4UmaV5Pk7cEh2hbcjgwe' })
const optimizelyClient = optimizelySdk.createInstance({ sdkKey: 'Jm4Qre4K2uNtdPT7TKs4v' })
if (optimizelyClient === null) {
throw new Error('Optimizely instance is null')
}
Expand Down
6 changes: 3 additions & 3 deletions src/components/TheWelcome.vue
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ import SupportIcon from './icons/IconSupport.vue'

We'll be following much of the
<a
href="https://docs.developers.optimizely.com/feature-experimentation/docs/react-quickstart"
href="https://docs.developers.optimizely.com/feature-experimentation/docs/javascript-browser-quickstart"
target="_blank"
rel="noopener"
>Optimizely React quick start documentation</a
>Optimizely Javascript quick start documentation</a
>
as a basis for this example app.
</WelcomeItem>
Expand Down Expand Up @@ -49,7 +49,7 @@ import SupportIcon from './icons/IconSupport.vue'
<template #heading>Get Started</template>

<p>
Once you have your Optimizely SDK key, you can add it to the
If you're using your own Optimizely SDK key, you can edit it to the
<code>src/App.vue</code>. Then, click the Run nav link 👈 to see the example in action.
</p>
</WelcomeItem>
Expand Down