https://github.com/optimizely/optimizely_dev_tools
https://github.com/optimizely/optimizely_dev_tools
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/optimizely/optimizely_dev_tools
- Owner: optimizely
- License: mit
- Archived: true
- Created: 2016-03-14T06:04:43.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2016-04-05T22:00:46.000Z (almost 10 years ago)
- Last Synced: 2025-03-01T12:17:19.610Z (about 1 year ago)
- Language: CSS
- Size: 896 KB
- Stars: 2
- Watchers: 81
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Optimizely Developer Toolkit
## Set up your development environment
### Clone this repo
```
git clone https://github.com/optimizely/optimizely_dev_tools.git
cd optimizely_dev_tools
```
### Set up your Python virtualenv
```
pip install virtualenv
virtualenv venv
source venv/bin/activate
python setup.py install
```
### Install nvm (Node Version Manager)
```
curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.31.0/install.sh | bash
```
## Creating a package
When creating a new package, create a directory specifically for integration development (e.g., `optimizely_integrations/`) and `cd` into that directory. From there, use the following commands to initialize and develop your integration package(s).
### Pre-configured
With the pre-configured command, the `opti` tool will provide you with a fully-functional integration package that you can modify to fit your integration.
```
opti new --default_config -config_type {integration type} -package_name {name of package}
```
### Unconfigured
With the unconfigured command, the `opti` tool will provide you with scaffolding that does not yet constitute a fully-functional integration package, but which includes in-line comments describing how to flesh out the missing pieces.
```
opti new -config_type {integration type} -package_name {name of package}
```
## Validating a package
```
opti validate {name of package}
```
## Running tests (Python and JavaScript) for a package
```
opti test {name of package}
```
## Tips
* Always activate your virtual environment when running the tool
* Don't hesitate to create an issue under this GitHub repo if you run into issues. We're eager to evolve this tooling!