Skip to content

Latest commit

 

History

History
38 lines (23 loc) · 1.43 KB

README.md

File metadata and controls

38 lines (23 loc) · 1.43 KB
Raw

👩🏻‍🔬 The Podcast A/B Testing Laboratory

Badges

Build Status Deploy

Contributing

Please consider reading our Contribution Guide before anything else.

Setup

Use make install to install the ruby dependencies.

Environment variables

  • PORT - HTTP port for the server, e.g.: 4815
  • REDIS_URL - URI to connect to Redis. e.g.: redis://127.0.0.1:6379
  • DHARMA_USER - User for the dashboard auth. e.g.: admin
  • DHARMA_PASSWORD - Password for the dashboard auth. e.g.: lost

Showtime

Finally, run make start to start the server.

The server will start at http://localhost:4815 by default.

The api will start at http://localhost:4815/experiments by default, check the endpoints section for more info. The dashboard will start at http://localhost:4815/dashboard by default.

Endpoints

  • GET /api/experiments?experiment=foo&controll=blue&alternatives[]=green&alternatives[]=yellow&identifier=0001 - Returns the alternative for an specific user
  • PUT /api/experiments?experiment=foo&identifier=0001 - Finish an experiment for a given user