As you probably know, I work as an API Evangelist at Akamai, and we’ve been working to decrease the learning curve for getting started with our APIs. We’ve got an excellent online tutorial and our evangelists travel around giving workshops to our customers so they can get some hands-on experience using the system.
Unfortunately, the system setup during workshops has revealed to me that the system setup for the exercises can frequently take longer than the actual exercises. Different operating systems, custom setup or configuration and specific development environments can make a relatively straightforward process challenging.
I found a similar challenge when working on my “Irresistible APIs” book. The second chapter is a mini-workshop to set up a local API and view it using a basic web page. However, just like with the Akamai workshop, system setup can be quite a challenge.
After looking around for ways to improve the experience, I landed on Docker. You may have encountered or heard of Docker in the context of complicated systems or development environments, where the primary goal is to maintain consistency between systems, and frequently the containers are connected (linked) together to create a fully operational system. This is a great use case for this technology, but I realized it was also an excellent framework for my simpler use case – helping people get a simple system up and running without having to install a new language or specific libraries. As an added bonus, the existing system’s development environment is not changed – when working with developers this is frequently a concern.
This system is fantastic for someone like me, who frequently lives in an interrupt-driven world – every time I change the github repository for the system, a new docker container is created, so any changes I make are immediately (or so) available for users to download.
To install this system, follow the installation guide for your operating system to get started with Docker. Start it up, then grab my container with the following command:
sudo docker run -i -t -p 80:5000 synedra/irresistible /bin/bash
The above command will put you in a root shell on the container (which is, essentially, a tiny linux box running on your system). To run the web application, issue the following command:
python app.py* Running on http://0.0.0.0:5000/
Since you’ve mapped the 5000 port to port 80 (with the docker run command), you need to grab the docker IP address:
At that point, you can point a browser to http://<docker_ip_address>:5000 and interact with the system. The console you have started will show the logs for your system as you interact with it.
Play with it, have fun, and contact me at @synedra on twitter if you have comments, questions, or remarks about this system.
If you are an Akamai customer interested in our APIs, contact our team at email@example.com to get instructions for installing the Docker container for our getting started repository.