README
¶
e2clicker
This service was written because this one was struggling to keep track of when to apply its estrogen patches, so it built a service to keep track of that for it. Being a pure Go service that relies on Gotify to send out push notifications to its phone, no Java code was needed.
Architecture
- Web frontend that allows recording HRT history and displaying statistics
- Configuration:
- Recommended time intervals for HRT
- Gotify integration: push notifications when it's time to do HRT
Developing
e2clicker is designed so that you only need Nix to bootstrap the development process.
- First, run
nix developto enter the Nix shell. You may also choose to use Direnv withuse flakefor an easier time. - Then, run
just devto start the development server. This command will automatically start a Zellij session consisting of:- A NixOS virtual machine, which contains all the dependencies needed for e2clicker's backend to operate.
- A Vite development server, which automatically reverse proxies API calls to the backend virtual machine while allowing hot reloading.
- To stop the development server:
- First shut off the virtual machine gracefully by running
shutdown nowon the top pane. - Then, stop the Vite server by focusing on the bottom pane and pressing
Ctrl+C. - Finally, you may exit out of all the Zellij panes. This will close Zellij entirely.
- First shut off the virtual machine gracefully by running
Building
e2clicker exposes the backend and frontend packages as 2 separate Nix flake outputs:
git+file:///home/diamond/Projects/diamondburned/e2clicker
└───packages
└───<ARCHITECTURE>
├───e2clicker-backend: package 'e2clicker-backend'
└───e2clicker-frontend: package 'e2clicker-frontend'
You can build these 2 packages without needing to clone the repository by running the following:
nix build "github:diamondburned/e2clicker#e2clicker-backend"
nix build "github:diamondburned/e2clicker#e2clicker-frontend"
Deploying
e2clicker exposes a NixOS module that can be used to deploy it onto a server.
It also exposes a PostgreSQL module that initializes the e2clicker database for it to use in the same machine. This module is optional; you can choose to use any PostgreSQL database as needed.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
e2clicker-backend
command
|
|
|
vapid-generate
command
|
|
|
internal
|
|
|
publicerrors
Package publicerrors provides a way to mark errors as public or private.
|
Package publicerrors provides a way to mark errors as public or private. |
|
sqlc/postgresqlc
Package postgresqlc contains raw SQL queries for the storage services and wrapper functions to use them.
|
Package postgresqlc contains raw SQL queries for the storage services and wrapper functions to use them. |
|
nix
|
|
|
modules/e2clicker
Code generated by nixmod2go.
|
Code generated by nixmod2go. |
|
services
|
|
|
api/openapi
Package openapi provides primitives to interact with the openapi HTTP API.
|
Package openapi provides primitives to interact with the openapi HTTP API. |
|
base/openapi
Package openapi provides primitives to interact with the openapi HTTP API.
|
Package openapi provides primitives to interact with the openapi HTTP API. |
|
dosage/openapi
Package openapi provides primitives to interact with the openapi HTTP API.
|
Package openapi provides primitives to interact with the openapi HTTP API. |
|
notification
Package notification provides a way to send notifications to users.
|
Package notification provides a way to send notifications to users. |
|
notification/openapi
Package openapi provides primitives to interact with the openapi HTTP API.
|
Package openapi provides primitives to interact with the openapi HTTP API. |
|
storage/postgresql
Package postgresql provides an implementation of the storage service using PostgreSQL.
|
Package postgresql provides an implementation of the storage service using PostgreSQL. |
|
user
Package user provides services for managing users.
|
Package user provides services for managing users. |
|
user/openapi
Package openapi provides primitives to interact with the openapi HTTP API.
|
Package openapi provides primitives to interact with the openapi HTTP API. |