Strikes

Strikes is a simple CLI tool to hold people or things accountable for their mistakes.

Keep in mind that it is not intended for serious use. It's just a fun project to play around with Rust and AWS Lambda. At its core, it's a simple CRUD app.

Description

Strikes can be used to track (add, list, delete) strikes for a person, team or anything else you want to track. The tool can be used with a remote server or locally.

Tech Stack

• Rust
• Terraform
• HTMX
• Handlebars
• AWS

AWS Infrastructure

Installation

On macOS using homebrew:

brew tap tbsklg/strikes
brew install strikes

There are specific binaries available. You can choose the release for your platform from the releases page. The binary is a standalone executable and does not require installation.

Example for the Linux binary:

Linux

tar -xvzf strikes-0.0.1-alpha-x86_64-unknown-linux-musl.tar.gz -C <path-to-install>

After extracting the binary, you may need to add the path to your PATH environment variable.

Usage

Simple CLI tool to track and assign strikes

Usage: strikes [OPTIONS] [COMMAND]

Commands:
  strike        Add a strike
  ls            List all strikes
  clear         Clear strikes
  check-health  Check health of the client
  help          Print this message or the help of the given subcommand(s)

Options:
  -c, --config-path <CONFIG_PATH>
          Specify the path to the configuration file

  -h, --help
          Print help (see a summary with '-h')

  -V, --version
          Print version

Use with a remote server

You can use a remote server to store the strikes. Either you get access to an existing server or you can deploy the infractructure to your AWS account yourself. Anyways you need to provide the URL to the server and an API key.

Use locally

You can use the local client without a remote server. It will generate a JSON file where the strikes are stored.

Configuration file

Provide a configuration file at .config/strikes/configuration.yaml. The remote server configuration has precedence over the local configuration.

remote:
    base_url: "https://strikes.example.com"
    api_key: "your-api-key"
local:
    db_path: "/path/to/db.json"

You can configure a different configuration file location by using the '--config-path' argument. The argument has precedence over the configuration file.

strikes --config-path /path/to/configuration.yaml strike guenther

Development

Pre-requisites

You'll need to install:

• Rust
• Docker
• Terraform
• AWS CLI

Deploy infrastructure to your AWS account

First of all you need to create a S3 bucket to store the terraform state. Navigate to the infrastructure/remote-state directory and run:

terraform init
terraform plan
terraform apply

This will create a S3 bucket and a DynamoDB table to store the terraform state.

Then build releases for all lambda functions within the /lambdas folder:

cargo lambda build --release

Afterwards you can deploy the infrastructure by navigating to the infrastructure directory and running:

terraform init
terraform plan
terraform apply

How to test the cli-client

Navigate to cli-client and run:

cargo test

How to test the infrastructure lambdas

Navigate to infrastructure/lambdas/tests and run:

docker-compose up -d

This will set up a DynamoDB local instance. Afterwards navigate back to infrastructure/lambdas and run:

cargo test