https://github.com/lebe-dev/mail-utilities-wizard

A tiny web-service that helps send meter readings to utility companies.
https://github.com/lebe-dev/mail-utilities-wizard

Last synced: 4 months ago
JSON representation

A tiny web-service that helps send meter readings to utility companies.

• Host: GitHub
• URL: https://github.com/lebe-dev/mail-utilities-wizard
• Owner: lebe-dev
• Created: 2024-07-13T08:14:02.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-10T11:01:40.000Z (almost 2 years ago)
• Last Synced: 2024-09-10T12:33:56.924Z (almost 2 years ago)
• Language: Rust
• Homepage:
• Size: 652 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Mail Utilities Wizard

A tiny web-service that helps send meter readings to utility companies.

[На русском](README.ru.md)

Main page with history data:

![Main page with history data](docs/en/history.png)

Send page:

![Send page](docs/en/send.png)

Letter preview:

![Letter preview feature](docs/en/letter-preview.png)

If company doesn't support direct mail send you can show a proper link and short manual:

![Link to utility company](docs/en/unsupported-counters.png)

## My story

My elderly parents have to send utility meter readings to various companies by mail. 

These companies don't have websites or mobile apps. Each utility company has its own letter format requirements, 

which causes difficulties for my parents.

It's a great opportunity to try [Axum](https://github.com/tokio-rs/axum) after many years with [actix](https://github.com/actix/actix-web) ;)

## Install

```shell

mkdir {data,templates,logs}

chmod -R 777 {data,logs}

# Put your mail template into `templates` folder

cp templates/example.txt templates/template.txt

# Prepare config files

cp config.yml-dist config.yml

cp locale.yml-dist locale.yml

# Edit config.yml

docker-compose up -d

```

Open http://localhost:8080

## How it works

A service provides web interface for user:

- Location

- Type of counter (water, electricity, etc)

- Account ID

- Month (default: previous month)

- Value

- Send button

## Template variables

Check `templates/example.txt`.

## RoadMap

1. Remind about data sending