Skip to content

mattwedge/Elixir-integrations-test

 
 

Repository files navigation

README

Purpose

This is a scale model of torx make, with the basic models and a simple api, it uses django rest framework to create a viewable api in the browser.

It is designed as a way to learn the mechanics of torx make.

Setup

To build the docker image: make build

To generate migrations: make migrations

To apply migrations: make migrate

To create a super user: make createsuperuser

To run the web server: make start

To read the logs: make logs

Please note: There's a env.example file, this project uses a .env file, please make sure you use the example file to initially set up environmental variables.

Usage

There is a web server that starts up and runs on: http://localhost:8000/

The test

Description Of Problem

At Elixir we often have to work with third party apis and ingest data into our system, we write bespoke programs that we call biz_rules to perform this integration. This test is a scale model of the sort of work we do quite frequently and is quite reflective of what a typical day might look like.

We have selected some apis and you may choose whichever one you like and write the code in the matching core/biz_rule.py file (please see the Services section below for details).

Your task can be broken down into three parts:

  • Study the api docs of the service you have chosen.
  • Write a biz_rule that consumes data from one of the api end points.
  • Ingests that into our test system using the provided models.

Please note: You will not need to write your own models!

The Services

Running your biz_rule

Running your code is as simple as make bizrule

About

A technical test for Elixir integrations

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 84.4%
  • Makefile 13.2%
  • Dockerfile 2.0%
  • Other 0.4%