You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
An experiment is a way to measure how a change to your product affects how people use it.
@@ -52,48 +51,47 @@ An experiment has three parts:
52
51
1. Analyze and collect the results to understand how the new feature impacted users
53
52
1. Do it again!
54
53
55
-
56
54
## Installation
57
55
58
-
1. Install [docker](https://www.docker.com/) on your machine
56
+
1.Install [docker](https://www.docker.com/) on your machine
59
57
60
-
1. Clone the repo
58
+
1.Clone the repo
61
59
62
60
git clone <your fork>
63
61
64
-
1. Copy the sample env file
62
+
1.Copy the sample env file
65
63
66
64
cp .env.sample .env
67
65
68
-
1. Set DEBUG=True for local development
66
+
1.Set DEBUG=True for local development
69
67
70
68
vi .env
71
69
72
-
1. Create a new secret key and put it in .env
70
+
1.Create a new secret key and put it in .env
73
71
74
72
make secretkey
75
73
76
-
1. Run tests
74
+
1.Run tests
77
75
78
76
make test
79
77
80
-
1. Run database migrations
78
+
1.Run database migrations
81
79
82
80
make migrate
83
81
84
-
1. Make a local user
82
+
1.Make a local user
85
83
86
84
make createuser
87
85
88
-
1. Load the initial data
86
+
1.Load the initial data
89
87
90
88
make load_locales_countries
91
89
92
-
1. Run a dev instance
90
+
1.Run a dev instance
93
91
94
92
make up
95
93
96
-
1. Navigate to it and add an SSL exception to your browser
94
+
1.Navigate to it and add an SSL exception to your browser
97
95
98
96
https://localhost/
99
97
@@ -106,167 +104,75 @@ Experimenter uses [docker](https://www.docker.com/) for all development, testing
106
104
The following helpful commands have been provided via a Makefile:
107
105
108
106
### build
107
+
109
108
Build the application container by executing the [build script](https://github.com/mozilla/experimenter/blob/master/scripts/build.sh)
110
109
111
110
### compose_build
111
+
112
112
Build the supporting services (nginx, postgresql) defined in the [compose file](https://github.com/mozilla/experimenter/blob/master/docker-compose.yml)
113
113
114
114
### up
115
+
115
116
Start a dev server listening on port 80 using the [Django runserver](https://docs.djangoproject.com/en/1.10/ref/django-admin/#runserver)
116
117
117
118
### test
119
+
118
120
Run the Django test suite with code coverage
119
121
120
122
### lint
123
+
121
124
Run flake8 against the code
122
125
123
126
### check
127
+
124
128
Run both test and lint
125
129
126
130
### migrate
131
+
127
132
Apply all django migrations
128
133
129
134
### createuser
135
+
130
136
Create an admin user in the local dev instance
131
137
132
138
### load_locales_countries
139
+
133
140
Populates locales and countries
134
141
135
142
### load_dummy_experiments
143
+
136
144
Populates db with dummy experiments
137
145
138
146
### shell
147
+
139
148
Start an ipython shell inside the container (this lets you import and test code, interact with the db, etc)
140
149
141
150
### bash
151
+
142
152
Start a bash shell inside the container (this lets you interact with the containerized filesystem)
143
153
144
154
### ssl
155
+
145
156
Create dummy SSL certs to use the dev server over a locally secure
146
157
connection. This helps test client behaviour with a secure
147
158
connection. This task is run automatically when needed.
148
159
149
160
### kill
161
+
150
162
Stop and delete all docker containers.
151
-
WARNING: this will remove your database and all data. Use this to reset your dev environment.
163
+
WARNING: this will remove your database and all data. Use this to reset your dev environment.
152
164
153
165
### refresh
166
+
154
167
Will run kill, migrate, load_locales_countries load_dummy_experiments
155
168
156
169
### up_all
170
+
157
171
will start up a normandy and delivery console instance. Prereqs. Symlink normandy and delivery console eg. `ln -s ../normandy normandy`, ensure user is assigned superuser status
158
172
159
173
## API
160
174
161
-
### GET /api/v1/experiments/
162
-
List all of the started experiments.
163
-
164
-
#### Optional Query Parameters
165
-
status - Return only the experiments with the given status, options are:
"countries": [{"code": "US", "name": "United States of America"}],
181
-
"control":{
182
-
"description":"Eos sunt adipisci beatae. Aut sunt totam maiores reprehenderit sed vero. Nam fugit sequi repellendus cumque. Fugit maxime suscipit eius quas iure exercitationem voluptatibus.",
"countries": [{"code": "US", "name": "United States of America"}],
222
-
"control":{
223
-
"description":"Eos sunt adipisci beatae. Aut sunt totam maiores reprehenderit sed vero. Nam fugit sequi repellendus cumque. Fugit maxime suscipit eius quas iure exercitationem voluptatibus.",
API documentation can be found [here](https://htmlpreview.github.io/?https://github.com/mozilla/experimenter/blob/master/app/experimenter/docs/swagger-ui.html)
0 commit comments