Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/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.
https://github.com/olivervea/veachron

Last synced: 5 days ago
JSON representation

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.

Awesome Lists containing this project

README

        

# 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](https://olivervea.github.io/posts/veachron/), 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:

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

Navigate to the directory:

```bash
cd veachron
```

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

```bash
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](http://ui.localhost) for the UI and [http://api.localhost](http://api.localhost) for the API.