Skip to content

Commit b009bb3

Browse files
[Hack Days] Updates for accuracy (#1)
* Update README * Update Starter SDK key * Update the Welcome instructions * Update devcontainer name * Update SDK key again
1 parent 6d93f5c commit b009bb3

File tree

4 files changed

+9
-10
lines changed

4 files changed

+9
-10
lines changed

.devcontainer/devcontainer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "Optimizely VueJS Starter Kit",
2+
"name": "Optimizely Vue.js Starter Kit",
33

44
"build": {
55
"dockerfile": "Dockerfile",

README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Optimizely Vue.js Starter Kit
22

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

55
## Prerequisites
66

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

1717
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.
1818
2. Enter the repository address `https://github.com/optimizely/vue-js-starter-kit`.
19-
3. If asked, choose the `main` branch.
20-
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:
19+
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:
2120

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

2827
## To Exit
2928

src/App.vue

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import { RouterLink, RouterView } from 'vue-router'
44
import HelloWorld from './components/HelloWorld.vue'
55
import optimizelySdk from '@optimizely/optimizely-sdk'
66
7-
const optimizelyClient = optimizelySdk.createInstance({ sdkKey: 'K4UmaV5Pk7cEh2hbcjgwe' })
7+
const optimizelyClient = optimizelySdk.createInstance({ sdkKey: 'Jm4Qre4K2uNtdPT7TKs4v' })
88
if (optimizelyClient === null) {
99
throw new Error('Optimizely instance is null')
1010
}

src/components/TheWelcome.vue

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@ import SupportIcon from './icons/IconSupport.vue'
1515

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

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

0 commit comments

Comments
 (0)