Simple API

Simple Python API with Automation files for deploying the Azure Resources and packaging them into a container.
Explore »

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
3. Usage
4. Roadmap
5. Contact

About The Project

A Proof of concept consisting of a single web-application and a single database. The service will accept a POST request that will persist the timestamp of that event into a database.

(back to top)

Built With

• Flask
• Docker
• Azure
• Terraform

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Installation

1. Clone the repo

   git clone https://github.com/tp-allen/simple_api.git

2. Install PIP Modules

   pip install -r requirements.txt

3. Build Docker Image

   docker build -t time_app .

4. Run Docker Container

   docker run -d --env-file ./env.list -p 5000:5000 time_app

(back to top)

Usage

The web API can use a curl command (curl -X POST http://app-timeapp-dev-001.azurewebsites.net/date)

The deployment of the App has been automated for use within Azure DevOps Pipelines.

The deployment of the resources has been terrafromed and can be created using the following tf commands.

terrafrom init
terraform plan -var-file terraform.tfvars
terraform apply -var-file terraform.tfvars

(back to top)

Roadmap

• Add Log Analytics resources
• Scale-Up Scale-Down events
• Backup and Restore DB
• Add Multi-region Support
  • Additional Instances
  • Azure CDN

(back to top)

Contact

Your Name - @tp_allen_ - [email protected]

Project Link: https://github.com/tp-allen/simple_api

(back to top)