https://github.com/artus9033/daily-reporter
Tiny Node utility to automatize daily reports, written in TypeScript
https://github.com/artus9033/daily-reporter
cli daily-report daily-reports mail nodejs smtp typescript
Last synced: 2 months ago
JSON representation
Tiny Node utility to automatize daily reports, written in TypeScript
- Host: GitHub
- URL: https://github.com/artus9033/daily-reporter
- Owner: artus9033
- License: mit
- Created: 2020-09-02T12:43:33.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-05-12T11:36:51.000Z (about 4 years ago)
- Last Synced: 2025-01-20T05:41:09.391Z (4 months ago)
- Topics: cli, daily-report, daily-reports, mail, nodejs, smtp, typescript
- Language: TypeScript
- Homepage:
- Size: 208 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Daily Reporter
A utility that helps to create standardized daily reports by automatically filling parts of the email such as the contents, including date, greeting customized to match the time of day when writing, or the signature of the email.
The reporter interactively asks You for it's config on the first run & for the tasks You want to include in a daily report each time it is run.
Settings (`config.json`) & recipients (`recipients.json`) are automatically checked & sanitized if needed.
## Contents
- [Daily Reporter](#daily-reporter)
- [Contents](#contents)
- [Scripts](#scripts)
- [Screenshots](#screenshots)
- [Binary download](#binary-download)
## Scripts
The utility can either be run in development mode, watching for source file changes with `npm run dev` / `npm run start` (they are equivalent), or it can be packaged to an executable file with `npm run package`.
Also, `npm run build` is available, which transpiles TypeScript code from `src/` to JavaScript in `build/`. This command is called by `npm run package` before the actual binary packaging process.
## Screenshots
First time configuration
Utility running
## Binary download
This repository utilizes Github workflows to automatically transpile, package & release a binary distribution of the tool. You can find the newest version on the [releases page](https://github.com/artus9033/daily-reporter/releases).