brendanmckenzie / brief-me-up

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Brief Me Up

Brief Me Up is a Node.js application built in TypeScript that sends a daily email with useful information such as weather, headlines, fun facts, and gym workouts. The application is designed to be run on a cron job, allowing you to receive your daily email at the same time every day.

Features

  • Sends a daily email with weather information, headlines, fun facts, and gym workouts.
  • Built in TypeScript for better type safety and code organization.
  • Easy to configure and customize to fit your specific needs.

Example

See docs/example.png for an example email.

Getting Started

Prerequisites

  • Node.js (v14 or higher)
  • npm or yarn

Installation

  • Clone the repository: git clone https://github.com/your-username/daily-assistant.git
  • Install dependencies: yarn install
  • Copy the example configuration file and update it with your own information: cp .env.example .env
  • Run the application: yarn start

Note: The application is designed to be run on a cron job. Please refer to your operating system's documentation for instructions on how to set up a cron job.

Configuration

The application can be configured using environment variables. See the .env.example file for a list of available options.

Contributing

Contributions are welcome! If you would like to contribute to the project, please create a pull request with your changes.

License

This project is licensed under the MIT License. See the LICENSE file for more information.

About

License:MIT License


Languages

Language:TypeScript 63.1%Language:HCL 26.2%Language:JavaScript 3.8%Language:Shell 3.6%Language:CSS 1.9%Language:Handlebars 1.4%