Add strikes remote (#14)

Author: tbsklg

.github/workflows/infrastructure.yml

@@ -24,13 +24,22 @@ jobs:
       - uses: actions/checkout@v4
       - uses: hashicorp/setup-terraform@v3
 
+      - name: Run docker-compose
+        uses: hoverkraft-tech/compose-action@v2.0.1
+        with:
+          compose-file: "infrastructure/lambdas/tests/docker-compose.yml"
+
       - name: Build & Test lambda
+        env:
+          AWS_DEFAULT_REGION: eu-central-1
+          AWS_ACCESS_KEY_ID: 223344
+          AWS_SECRET_ACCESS_KEY: wJalrXUtTHISI/DYNAMODB/bPxRfiCYEXAMPLEKEY
         run: |
           pip3 install cargo-lambda
           rustup update stable && rustup default stable
-          cargo lambda build --arm64 --release
+          cargo lambda build --release
           cargo test --verbose
-        working-directory: infrastructure/health
+        working-directory: infrastructure/lambdas
 
       - name: Configure AWS credentials
         uses: aws-actions/configure-aws-credentials@v4

README.md

@@ -19,36 +19,94 @@ tar -xvzf strikes-0.0.1-alpha-x86_64-unknown-linux-musl.tar.gz -C <path-to-insta
 After extracting the binary, you may need to add the path to your PATH environment variable.
 
 ## Usage
-- Add a strike to a user
 ```bash
-strikes strike <user>
-```
+Simple CLI tool to track and assign strikes
 
-- List all strikes
-```bash
-strikes ls
-```
+Usage: strikes [OPTIONS] [COMMAND]
 
-- Clear all strikes
-```bash
-strikes clear
+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 locally only
+## 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. 
-The default path is in your home directory at '.strikes/db.json'.
-You can configure a different location by using the '--db-path' argument or by providing a configuration file.
-The argument has precedence over the configuration file.
 
-### Configuration file
-The configuration file needs to be a yaml file.
+## Configuration file
+Provide a configuration file at ./strikes/configuration.yaml. The remote server configuration has precedence over the local configuration.
 
 ```yaml
+remote:
+    base_rul: "https://strikes.example.com"
+    api_key: "your-api-key"
 local:
-    db_path: /path/to/db.json
+    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.
+
 ```bash
 strikes --config-path /path/to/configuration.yaml strike guenther
 ```
+
+## Development
+### Pre-requisites
+You'll need to install:
+- [Rust](https://www.rust-lang.org/tools/install) 
+- [Docker](https://docs.docker.com/get-docker)
+- [Terraform](https://learn.hashicorp.com/tutorials/terraform/install-cli)
+- [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2.html)
+
+### 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:
+```bash
+terraform init
+terraform plan
+terraform apply
+```
+This will create a S3 bucket and a DynamoDB table to store the terraform state. Afterwards you can deploy the infrastructure by navigating to the infrastructure directory and running:
+
+```bash
+terraform init
+terraform plan
+terraform apply
+```
+
+### How to test the cli-client
+Navigate to cli-client and run:
+```bash
+cargo test
+```
+
+### How to test the infrastructure lambdas
+Navigate to infrastructure/lambdas/tests and run:
+
+```bash
+docker-compose up -d
+```
+
+This will set up a DynamoDB local instance. Afterwards navigate back to infrastructure/lambdas and run:
+
+
+```bash
+cargo test
+```