BirthdayRS Documentation

Welcome to BirthdayRS, a powerful birthday reminder system that supports both lunar and solar calendar birthdays with rich Chinese traditional culture information.

Quick Links

• Index

• Module Index

• Search

Project Overview

BirthdayRS is a modern birthday reminder system that provides:

• Dual Calendar Support: Solar (Gregorian) and Lunar (Chinese) calendar birthdays

• Rich Date Information: GanZhi, zodiac signs, festivals, solar terms, constellations

• Multiple Notifications: Email and ServerChan support

• Flexible Deployment: Local, Docker, and GitHub Actions

Documentation Contents

• Installation
  • Requirements
  • Install from Source
  • Development Installation
  • Docker Installation
  • Verify Installation
• Quick Start
  • Basic Usage
  • Commands
  • Testing
• Configuration
  • Configuration File Structure
  • Notification Settings
  • Recipients Configuration
  • Default Values
  • Birthday Formats
  • Email Templates
  • Example Configuration
• Modules
  • Core Modules
  • Notification Modules
• API Reference
  • Core Components
  • Configuration Classes
  • Notification Senders
  • Main Application
• Changelog
  • [Unreleased]
  • [0.1.0] - 2024-01-XX
• Contributing
  • How to Contribute
  • Development Setup
  • Running Tests
  • Code Style
  • Documentation
  • Project Structure
  • Coding Guidelines
  • License

Language Switch

• English

• 中文

Indices and tables

• Index

• Module Index

• Search