Skip to content

Commit ca2ffc4

Browse files
Add README content
1 parent 4a32b0c commit ca2ffc4

File tree

1 file changed

+56
-2
lines changed

1 file changed

+56
-2
lines changed

README.md

Lines changed: 56 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,56 @@
1-
# vue-js-starter-kit
2-
VueJS Starter Kit for Optimizely Feature Experimentation and Optimizely Full Stack (legacy)
1+
# Optimizely Vue.js Starter Kit
2+
3+
The goal of this repo is to get you to a running Vue app with Optimizely as fast as possible.
4+
5+
## Prerequisites
6+
7+
To run the application, you need to have the following installed:
8+
9+
- Visual Studio Code (VSCode)
10+
- Install extension [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
11+
- Docker or Docker Desktop
12+
13+
## Getting Started
14+
15+
To get started with the application, follow these steps:
16+
17+
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.
18+
2. Enter the repository address `https://github.com/optimizely/vue-js-starter-kit`
19+
3. 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:
21+
22+
```shell
23+
npm run dev
24+
```
25+
26+
## What To Do From Here
27+
28+
Take a look at the following Optimizely resources:
29+
30+
- [Javascript SDK](https://github.com/optimizely/javascript-sdk)
31+
- [Javascript Quickstart](https://docs.developers.optimizely.com/feature-experimentation/docs/javascript-browser-quickstart)
32+
- [Javascript SDK Documentation](https://docs.developers.optimizely.com/feature-experimentation/docs/javascript-sdk)
33+
34+
### Other Optimizely SDKs
35+
36+
- Agent - https://github.com/optimizely/agent
37+
38+
- Android - https://github.com/optimizely/android-sdk
39+
40+
- C# - https://github.com/optimizely/csharp-sdk
41+
42+
- Flutter - https://github.com/optimizely/optimizely-flutter-sdk
43+
44+
- Go - https://github.com/optimizely/go-sdk
45+
46+
- Java - https://github.com/optimizely/java-sdk
47+
48+
- PHP - https://github.com/optimizely/php-sdk
49+
50+
- Python - https://github.com/optimizely/python-sdk
51+
52+
- React - https://github.com/optimizely/react-sdk
53+
54+
- Ruby - https://github.com/optimizely/ruby-sdk
55+
56+
- Swift - https://github.com/optimizely/swift-sdk

0 commit comments

Comments
 (0)