This project provides an AI-powered divination tool, offering services like Tarot card readings, Chinese astrology (Bazi), name analysis, dream interpretation, and more. It targets users interested in traditional fortune-telling methods augmented by large language models, aiming to deliver accessible and engaging spiritual guidance.

How It Works

The application integrates with OpenAI's GPT models to process user queries and generate divinatory insights. It supports various traditional Chinese metaphysical systems, including Bazi (生辰八字), name analysis (姓名五格), and Plum Blossom Numerology (梅花易数), alongside Tarot and dream interpretation. The architecture appears to be a web application with a frontend and a Python backend.

Quick Start & Requirements

• Local Run: Requires pnpm for frontend build, Python 3.x, and pip. Create a .env file with api_key (required), api_base, github_client_id, github_client_secret, ad_client, and ad_slot.
• Docker: Deploy using the provided docker-compose.yaml with environment variables.
• Prerequisites: OpenAI API key is mandatory. GitHub OAuth credentials and ad network IDs are optional.

Highlighted Details

• Offers a comprehensive suite of divination methods, including Tarot, Bazi, name analysis, dream interpretation, and more.
• Supports both local deployment and Docker containerization.
• Includes options for API base URL and model selection for OpenAI integration.
• Features optional integration with GitHub for authentication and ad network IDs for monetization.

Maintenance & Community

No specific information on contributors, community channels, or roadmap is provided in the README.

Licensing & Compatibility

The license is not specified in the README.

Limitations & Caveats

The project relies heavily on external APIs (OpenAI, potentially GitHub) and requires users to manage their own API keys. The absence of explicit licensing information may pose compatibility concerns for commercial or broader use.