kalmonipa/howarethey repository overview

⁠HowAreThey

A reminder system to keep in touch with your friends. It's a simple tool to prompt you to get in touch with people that you might lose touch with over time.

If you define a notification service and pass in a webhook URL, it will send a message to your channel/device. Currently it only supports Discord and Ntfy. The message will look something like

HowAreThey
You should get in touch with Jack Reacher. You haven't spoken to them since 06/06/2023.

Currently, this is just intended as a backend web server with a few endpoints, storing the data in a SQLite database. Updating the info is a bit finnicky if you're not used to using CLI/Curl/etc.

I'm also working on a frontend web page for this but Javascript is hard and don't currently have the time to learn it at the moment.

⁠Usage

⁠To run the container

Replace the tag with the tag you want to use

docker run -p 8080:8080 -v $PWD/sql/:/home/hat/sql/ kalmonipa/howarethey:v0.16

See docker-compose.yaml for an example Docker Compose file.

⁠Examples

Here is a JSON object of an example person:

{
  "ID": "1",
  "Name": "Steve Carell",
  "LastContacted": "2023-06-06",
  "Birthday": "1962-08-16",
  "Notes": "Ask him how his store is going in Marshfield"
}

To update the notes for example, you can send a request using the /friends/:id endpoint. Only the keys that are provided will get updated.

curl "http://localhost:8080/friends/1" \
    --request PUT \
    --header "Content-Type: application/json" \
    --data "{\"Notes\":\"His store is going great\"}"

To update both the Notes and the LastContacted field, you would send something like this

curl "http://localhost:8080/friends/1" \
        --request PUT \
        --header "Content-Type: application/json" \
        --data "{\"LastContacted\":\"2024-04-17\",\"Notes\":\"His store is going great\"}"

Calling GET /friends/random will trigger a random friend to get chosen, their LastContacted field to get updated to today and a notification will get sent to your notification service specified in the env var (if any is set)

⁠Endpoints available

⁠Docker Config

⁠Development

Write any new tests and run the following commands from the root directory

⁠Unit tests

go test -v ./pkg/test/unit_test

⁠Integration tests

./run-integration-tests.sh

To skip the image build step (if you already have an image for your feature branch on your local machine), set the BUILD_IMAGE env var to false and run the int test script. i.e: BUILD_IMAGE="false" ./run-integration-tests.sh

If the tests pass submit a Pull Request with a detailed description.