Track and Trace API

This is a basic Flask API for tracking and tracing packages.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

What things you need to install the software and how to install them

• Python 3.9
• Pipenv
• Redis
• Docker (Optional)

Installing for local development

Clone the project from GitHub

git clone https://github.com/lmbarr/track-and-trace-api

Change into the project directory

cd track-and-trace-api

Install the project requirements

pipenv install --dev

Running the API locally

Set up the Redis Server

redis-server 

Edit redis connection to localhost. Set up the API Server. Inside your virtual environments run:

python main.py localhost

Running the API with Docker (Optional)

Clone the repo from github and place a .env (request it to me) file in the repository folder.

Build and run needed containers

docker-compose up -d

Retrieve an article: hit this endpoint on your prefer browser

http://127.0.0.1:5001/article?tracking_number=TN12345679&carrier=UPS