Skip to content

Commit

Permalink
Add minimal README instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
mkretz committed Jun 7, 2024
1 parent 37a127a commit 719b5f3
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,31 @@
A microservice for coordinating stateful workload on partitions of data

![It's a trap!](https://media.giphy.com/media/v1.Y2lkPTc5MGI3NjExMzEwdDRoaXJvMmgwdG1yejNsa28zNzh3ajI1OWdiYmUxMXZ1anpnaCZlcD12MV9naWZzX3NlYXJjaCZjdD1n/Z1LYiyIPhnG9O/giphy.gif)

## Clone the repository

```shell
git clone [email protected]:bespinian/ackbar.git
cd ./ackbar
```

## Run locally

1. Run a local instance of Redis in Docker

```shell
docker run --name ackbar-redis -d -p 6379:6379 redis
export REDIS_CONNECTION_STRING="localhost:6379"
```

2. Run `ackbar` from the source code

```shell
go run .
```

## Run in Kubernetes

```shell
kubectl apply -f k8s
```

0 comments on commit 719b5f3

Please sign in to comment.