A little reminders program. Meminders will send you text messages (or call you!) to remind you of things.
There are a few primary dependencies to Meminders:
- Go (though you can run it with Docker as well), and all the Go packages specified in go.mod.
- SQLite (though this could easily be swapped out).
- Twilio (for sending text messages and making calls).
Check out the test.env file to see what environment variables you'll need. The program will also blow up if any are lacking, so that helps.
There is a Makefile which won't necessarily set everything up for you, but provides some convenience methods for development.
Right now, Meminders has only one endpoint, POST /meminders. An example
request to a local server might look like this:
curl --location --request POST 'localhost:8080/reminders' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic YWRtaW46cGFzc3dvcmQ=' \
--data-raw '{"message": "This is a test. This is only a test.", "frequency": "once", "year": 2021, "month": "March", "hour": 15, "minute": 30, "day": 21, "zone": "America/Los_Angeles"}'
The program supports frequencies of "once", "daily", "weekly", and "monthly". The API does not (yet!) do a great job of validating inputs, so make sure if you set something for a given frequency, you send it a sensical set of other parameters (e.g. if you want a weekly reminder, tell it what day of the week).
By default, reminders will be sent via SMS. But you can add the call parameter to the
body ("call": true) to receive a phone call instead.
An additional... "feature" is that I've set it up such that any request to a non-existant path will result a tarpit response (quasi-infinite streamed http response). You may not want this.
There's a nice little GitHub Actions workflow set up that you could use to put this thing on a server, if you were to fork the repo. You'd probably want to sub out any reference to jonathanwthom for your own username.
One fun use case is to create a client for Meminders using Siri Shortcuts; this is what I've done, but there are probably other ways to make it useful.
I welcome any and all issues and PRs. The next priority for this project is to support more actions on saved reminders via API.
MIT