OliverVea / veachron

This is an application for tracking and comparing time use in code. The primary purpose is for me to practice CI/CD principles by publishing a python package for the application, a docker image based on the application, autogenerated SDK packages, and a AWS ECS deployment.

Introduction

veachron is a web application which can be used for timing anything that can make http requests.

The project is described on my personal project page, which describes installation, configuration and usage of the application.

This readme.md describes how to install and use the source code of the application.

Installation

Firstly, clone the repository:

git clone https://github.com/OliverVea/veachron.git

Navigate to the directory:

cd veachron

Use the docker-compose.yml file to spin up the application:

docker compose up --build

The --build flag can be omitted to use prebuilt images from Docker Hub.

Usage

After spinning up the application, it can be reaced at http://ui.localhost for the UI and http://api.localhost for the API.